block/qcow2.c

   1 /*
   2  * Block driver for the QCOW version 2 format
   3  *
   4  * Copyright (c) 2004-2006 Fabrice Bellard
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24 #include "qemu-common.h"
  25 #include "block_int.h"
  26 #include "module.h"
  27 #include <zlib.h>
  28 #include "aes.h"
  29 #include "block/qcow2.h"
  30 #include "qemu-error.h"
  31 #include "qerror.h"
  32
  33 /*
  34   Differences with QCOW:
  35
  36   - Support for multiple incremental snapshots.
  37   - Memory management by reference counts.
  38   - Clusters which have a reference count of one have the bit
  39     QCOW_OFLAG_COPIED to optimize write performance.
  40   - Size of compressed clusters is stored in sectors to reduce bit usage
  41     in the cluster offsets.
  42   - Support for storing additional data (such as the VM state) in the
  43     snapshots.
  44   - If a backing store is used, the cluster size is not constrained
  45     (could be backported to QCOW).
  46   - L2 tables have always a size of one cluster.
  47 */
  48
  49
  50 typedef struct {
  51     uint32_t magic;
  52     uint32_t len;
  53 } QCowExtension;
  54 #define  QCOW2_EXT_MAGIC_END 0
  55 #define  QCOW2_EXT_MAGIC_BACKING_FORMAT 0xE2792ACA
  56
  57 static int qcow2_probe(const uint8_t *buf, int buf_size, const char *filename)
  58 {
  59     const QCowHeader *cow_header = (const void *)buf;
  60
  61     if (buf_size >= sizeof(QCowHeader) &&
  62         be32_to_cpu(cow_header->magic) == QCOW_MAGIC &&
  63         be32_to_cpu(cow_header->version) >= QCOW_VERSION)
  64         return 100;
  65     else
  66         return 0;
  67 }
  68
  69
  70 /*
  71  * read qcow2 extension and fill bs
  72  * start reading from start_offset
  73  * finish reading upon magic of value 0 or when end_offset reached
  74  * unknown magic is skipped (future extension this version knows nothing about)
  75  * return 0 upon success, non-0 otherwise
  76  */
  77 static int qcow2_read_extensions(BlockDriverState *bs, uint64_t start_offset,
  78                                  uint64_t end_offset)
  79 {
  80     BDRVQcowState *s = bs->opaque;
  81     QCowExtension ext;
  82     uint64_t offset;
  83     int ret;
  84
  85 #ifdef DEBUG_EXT
  86     printf("qcow2_read_extensions: start=%ld end=%ld\n", start_offset, end_offset);
  87 #endif
  88     offset = start_offset;
  89     while (offset < end_offset) {
  90
  91 #ifdef DEBUG_EXT
  92         /* Sanity check */
  93         if (offset > s->cluster_size)
  94             printf("qcow2_read_extension: suspicious offset %lu\n", offset);
  95
  96         printf("attempting to read extended header in offset %lu\n", offset);
  97 #endif
  98
  99         if (bdrv_pread(bs->file, offset, &ext, sizeof(ext)) != sizeof(ext)) {
 100             fprintf(stderr, "qcow2_read_extension: ERROR: "
 101                     "pread fail from offset %" PRIu64 "\n",
 102                     offset);
 103             return 1;
 104         }
 105         be32_to_cpus(&ext.magic);
 106         be32_to_cpus(&ext.len);
 107         offset += sizeof(ext);
 108 #ifdef DEBUG_EXT
 109         printf("ext.magic = 0x%x\n", ext.magic);
 110 #endif
 111         switch (ext.magic) {
 112         case QCOW2_EXT_MAGIC_END:
 113             return 0;
 114
 115         case QCOW2_EXT_MAGIC_BACKING_FORMAT:
 116             if (ext.len >= sizeof(bs->backing_format)) {
 117                 fprintf(stderr, "ERROR: ext_backing_format: len=%u too large"
 118                         " (>=%zu)\n",
 119                         ext.len, sizeof(bs->backing_format));
 120                 return 2;
 121             }
 122             if (bdrv_pread(bs->file, offset , bs->backing_format,
 123                            ext.len) != ext.len)
 124                 return 3;
 125             bs->backing_format[ext.len] = '\0';
 126 #ifdef DEBUG_EXT
 127             printf("Qcow2: Got format extension %s\n", bs->backing_format);
 128 #endif
 129             break;
 130
 131         default:
 132             /* unknown magic - save it in case we need to rewrite the header */
 133             {
 134                 Qcow2UnknownHeaderExtension *uext;
 135
 136                 uext = g_malloc0(sizeof(*uext)  + ext.len);
 137                 uext->magic = ext.magic;
 138                 uext->len = ext.len;
 139                 QLIST_INSERT_HEAD(&s->unknown_header_ext, uext, next);
 140
 141                 ret = bdrv_pread(bs->file, offset , uext->data, uext->len);
 142                 if (ret < 0) {
 143                     return ret;
 144                 }
 145             }
 146             break;
 147         }
 148
 149         offset += ((ext.len + 7) & ~7);
 150     }
 151
 152     return 0;
 153 }
 154
 155 static void cleanup_unknown_header_ext(BlockDriverState *bs)
 156 {
 157     BDRVQcowState *s = bs->opaque;
 158     Qcow2UnknownHeaderExtension *uext, *next;
 159
 160     QLIST_FOREACH_SAFE(uext, &s->unknown_header_ext, next, next) {
 161         QLIST_REMOVE(uext, next);
 162         g_free(uext);
 163     }
 164 }
 165
 166 static int qcow2_open(BlockDriverState *bs, int flags)
 167 {
 168     BDRVQcowState *s = bs->opaque;
 169     int len, i, ret = 0;
 170     QCowHeader header;
 171     uint64_t ext_end;
 172     bool writethrough;
 173
 174     ret = bdrv_pread(bs->file, 0, &header, sizeof(header));
 175     if (ret < 0) {
 176         goto fail;
 177     }
 178     be32_to_cpus(&header.magic);
 179     be32_to_cpus(&header.version);
 180     be64_to_cpus(&header.backing_file_offset);
 181     be32_to_cpus(&header.backing_file_size);
 182     be64_to_cpus(&header.size);
 183     be32_to_cpus(&header.cluster_bits);
 184     be32_to_cpus(&header.crypt_method);
 185     be64_to_cpus(&header.l1_table_offset);
 186     be32_to_cpus(&header.l1_size);
 187     be64_to_cpus(&header.refcount_table_offset);
 188     be32_to_cpus(&header.refcount_table_clusters);
 189     be64_to_cpus(&header.snapshots_offset);
 190     be32_to_cpus(&header.nb_snapshots);
 191
 192     if (header.magic != QCOW_MAGIC) {
 193         ret = -EINVAL;
 194         goto fail;
 195     }
 196     if (header.version != QCOW_VERSION) {
 197         char version[64];
 198         snprintf(version, sizeof(version), "QCOW version %d", header.version);
 199         qerror_report(QERR_UNKNOWN_BLOCK_FORMAT_FEATURE,
 200             bs->device_name, "qcow2", version);
 201         ret = -ENOTSUP;
 202         goto fail;
 203     }
 204     if (header.cluster_bits < MIN_CLUSTER_BITS ||
 205         header.cluster_bits > MAX_CLUSTER_BITS) {
 206         ret = -EINVAL;
 207         goto fail;
 208     }
 209     if (header.crypt_method > QCOW_CRYPT_AES) {
 210         ret = -EINVAL;
 211         goto fail;
 212     }
 213     s->crypt_method_header = header.crypt_method;
 214     if (s->crypt_method_header) {
 215         bs->encrypted = 1;
 216     }
 217     s->cluster_bits = header.cluster_bits;
 218     s->cluster_size = 1 << s->cluster_bits;
 219     s->cluster_sectors = 1 << (s->cluster_bits - 9);
 220     s->l2_bits = s->cluster_bits - 3; /* L2 is always one cluster */
 221     s->l2_size = 1 << s->l2_bits;
 222     bs->total_sectors = header.size / 512;
 223     s->csize_shift = (62 - (s->cluster_bits - 8));
 224     s->csize_mask = (1 << (s->cluster_bits - 8)) - 1;
 225     s->cluster_offset_mask = (1LL << s->csize_shift) - 1;
 226     s->refcount_table_offset = header.refcount_table_offset;
 227     s->refcount_table_size =
 228         header.refcount_table_clusters << (s->cluster_bits - 3);
 229
 230     s->snapshots_offset = header.snapshots_offset;
 231     s->nb_snapshots = header.nb_snapshots;
 232
 233     /* read the level 1 table */
 234     s->l1_size = header.l1_size;
 235     s->l1_vm_state_index = size_to_l1(s, header.size);
 236     /* the L1 table must contain at least enough entries to put
 237        header.size bytes */
 238     if (s->l1_size < s->l1_vm_state_index) {
 239         ret = -EINVAL;
 240         goto fail;
 241     }
 242     s->l1_table_offset = header.l1_table_offset;
 243     if (s->l1_size > 0) {
 244         s->l1_table = g_malloc0(
 245             align_offset(s->l1_size * sizeof(uint64_t), 512));
 246         ret = bdrv_pread(bs->file, s->l1_table_offset, s->l1_table,
 247                          s->l1_size * sizeof(uint64_t));
 248         if (ret < 0) {
 249             goto fail;
 250         }
 251         for(i = 0;i < s->l1_size; i++) {
 252             be64_to_cpus(&s->l1_table[i]);
 253         }
 254     }
 255
 256     /* alloc L2 table/refcount block cache */
 257     writethrough = ((flags & BDRV_O_CACHE_WB) == 0);
 258     s->l2_table_cache = qcow2_cache_create(bs, L2_CACHE_SIZE, writethrough);
 259     s->refcount_block_cache = qcow2_cache_create(bs, REFCOUNT_CACHE_SIZE,
 260         writethrough);
 261
 262     s->cluster_cache = g_malloc(s->cluster_size);
 263     /* one more sector for decompressed data alignment */
 264     s->cluster_data = qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size
 265                                   + 512);
 266     s->cluster_cache_offset = -1;
 267     s->flags = flags;
 268
 269     ret = qcow2_refcount_init(bs);
 270     if (ret != 0) {
 271         goto fail;
 272     }
 273
 274     QLIST_INIT(&s->cluster_allocs);
 275
 276     /* read qcow2 extensions */
 277     if (header.backing_file_offset) {
 278         ext_end = header.backing_file_offset;
 279     } else {
 280         ext_end = s->cluster_size;
 281     }
 282     if (qcow2_read_extensions(bs, sizeof(header), ext_end)) {
 283         ret = -EINVAL;
 284         goto fail;
 285     }
 286
 287     /* read the backing file name */
 288     if (header.backing_file_offset != 0) {
 289         len = header.backing_file_size;
 290         if (len > 1023) {
 291             len = 1023;
 292         }
 293         ret = bdrv_pread(bs->file, header.backing_file_offset,
 294                          bs->backing_file, len);
 295         if (ret < 0) {
 296             goto fail;
 297         }
 298         bs->backing_file[len] = '\0';
 299     }
 300
 301     ret = qcow2_read_snapshots(bs);
 302     if (ret < 0) {
 303         goto fail;
 304     }
 305
 306     /* Initialise locks */
 307     qemu_co_mutex_init(&s->lock);
 308
 309 #ifdef DEBUG_ALLOC
 310     {
 311         BdrvCheckResult result = {0};
 312         qcow2_check_refcounts(bs, &result);
 313     }
 314 #endif
 315     return ret;
 316
 317  fail:
 318     cleanup_unknown_header_ext(bs);
 319     qcow2_free_snapshots(bs);
 320     qcow2_refcount_close(bs);
 321     g_free(s->l1_table);
 322     if (s->l2_table_cache) {
 323         qcow2_cache_destroy(bs, s->l2_table_cache);
 324     }
 325     g_free(s->cluster_cache);
 326     qemu_vfree(s->cluster_data);
 327     return ret;
 328 }
 329
 330 static int qcow2_set_key(BlockDriverState *bs, const char *key)
 331 {
 332     BDRVQcowState *s = bs->opaque;
 333     uint8_t keybuf[16];
 334     int len, i;
 335
 336     memset(keybuf, 0, 16);
 337     len = strlen(key);
 338     if (len > 16)
 339         len = 16;
 340     /* XXX: we could compress the chars to 7 bits to increase
 341        entropy */
 342     for(i = 0;i < len;i++) {
 343         keybuf[i] = key[i];
 344     }
 345     s->crypt_method = s->crypt_method_header;
 346
 347     if (AES_set_encrypt_key(keybuf, 128, &s->aes_encrypt_key) != 0)
 348         return -1;
 349     if (AES_set_decrypt_key(keybuf, 128, &s->aes_decrypt_key) != 0)
 350         return -1;
 351 #if 0
 352     /* test */
 353     {
 354         uint8_t in[16];
 355         uint8_t out[16];
 356         uint8_t tmp[16];
 357         for(i=0;i<16;i++)
 358             in[i] = i;
 359         AES_encrypt(in, tmp, &s->aes_encrypt_key);
 360         AES_decrypt(tmp, out, &s->aes_decrypt_key);
 361         for(i = 0; i < 16; i++)
 362             printf(" %02x", tmp[i]);
 363         printf("\n");
 364         for(i = 0; i < 16; i++)
 365             printf(" %02x", out[i]);
 366         printf("\n");
 367     }
 368 #endif
 369     return 0;
 370 }
 371
 372 static int coroutine_fn qcow2_co_is_allocated(BlockDriverState *bs,
 373         int64_t sector_num, int nb_sectors, int *pnum)
 374 {
 375     BDRVQcowState *s = bs->opaque;
 376     uint64_t cluster_offset;
 377     int ret;
 378
 379     *pnum = nb_sectors;
 380     /* FIXME We can get errors here, but the bdrv_co_is_allocated interface
 381      * can't pass them on today */
 382     qemu_co_mutex_lock(&s->lock);
 383     ret = qcow2_get_cluster_offset(bs, sector_num << 9, pnum, &cluster_offset);
 384     qemu_co_mutex_unlock(&s->lock);
 385     if (ret < 0) {
 386         *pnum = 0;
 387     }
 388
 389     return (cluster_offset != 0);
 390 }
 391
 392 /* handle reading after the end of the backing file */
 393 int qcow2_backing_read1(BlockDriverState *bs, QEMUIOVector *qiov,
 394                   int64_t sector_num, int nb_sectors)
 395 {
 396     int n1;
 397     if ((sector_num + nb_sectors) <= bs->total_sectors)
 398         return nb_sectors;
 399     if (sector_num >= bs->total_sectors)
 400         n1 = 0;
 401     else
 402         n1 = bs->total_sectors - sector_num;
 403
 404     qemu_iovec_memset_skip(qiov, 0, 512 * (nb_sectors - n1), 512 * n1);
 405
 406     return n1;
 407 }
 408
 409 static coroutine_fn int qcow2_co_readv(BlockDriverState *bs, int64_t sector_num,
 410                           int remaining_sectors, QEMUIOVector *qiov)
 411 {
 412     BDRVQcowState *s = bs->opaque;
 413     int index_in_cluster, n1;
 414     int ret;
 415     int cur_nr_sectors; /* number of sectors in current iteration */
 416     uint64_t cluster_offset = 0;
 417     uint64_t bytes_done = 0;
 418     QEMUIOVector hd_qiov;
 419     uint8_t *cluster_data = NULL;
 420
 421     qemu_iovec_init(&hd_qiov, qiov->niov);
 422
 423     qemu_co_mutex_lock(&s->lock);
 424
 425     while (remaining_sectors != 0) {
 426
 427         /* prepare next request */
 428         cur_nr_sectors = remaining_sectors;
 429         if (s->crypt_method) {
 430             cur_nr_sectors = MIN(cur_nr_sectors,
 431                 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors);
 432         }
 433
 434         ret = qcow2_get_cluster_offset(bs, sector_num << 9,
 435             &cur_nr_sectors, &cluster_offset);
 436         if (ret < 0) {
 437             goto fail;
 438         }
 439
 440         index_in_cluster = sector_num & (s->cluster_sectors - 1);
 441
 442         qemu_iovec_reset(&hd_qiov);
 443         qemu_iovec_copy(&hd_qiov, qiov, bytes_done,
 444             cur_nr_sectors * 512);
 445
 446         if (!cluster_offset) {
 447
 448             if (bs->backing_hd) {
 449                 /* read from the base image */
 450                 n1 = qcow2_backing_read1(bs->backing_hd, &hd_qiov,
 451                     sector_num, cur_nr_sectors);
 452                 if (n1 > 0) {
 453                     BLKDBG_EVENT(bs->file, BLKDBG_READ_BACKING_AIO);
 454                     qemu_co_mutex_unlock(&s->lock);
 455                     ret = bdrv_co_readv(bs->backing_hd, sector_num,
 456                                         n1, &hd_qiov);
 457                     qemu_co_mutex_lock(&s->lock);
 458                     if (ret < 0) {
 459                         goto fail;
 460                     }
 461                 }
 462             } else {
 463                 /* Note: in this case, no need to wait */
 464                 qemu_iovec_memset(&hd_qiov, 0, 512 * cur_nr_sectors);
 465             }
 466         } else if (cluster_offset & QCOW_OFLAG_COMPRESSED) {
 467             /* add AIO support for compressed blocks ? */
 468             ret = qcow2_decompress_cluster(bs, cluster_offset);
 469             if (ret < 0) {
 470                 goto fail;
 471             }
 472
 473             qemu_iovec_from_buffer(&hd_qiov,
 474                 s->cluster_cache + index_in_cluster * 512,
 475                 512 * cur_nr_sectors);
 476         } else {
 477             if ((cluster_offset & 511) != 0) {
 478                 ret = -EIO;
 479                 goto fail;
 480             }
 481
 482             if (s->crypt_method) {
 483                 /*
 484                  * For encrypted images, read everything into a temporary
 485                  * contiguous buffer on which the AES functions can work.
 486                  */
 487                 if (!cluster_data) {
 488                     cluster_data =
 489                         qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
 490                 }
 491
 492                 assert(cur_nr_sectors <=
 493                     QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors);
 494                 qemu_iovec_reset(&hd_qiov);
 495                 qemu_iovec_add(&hd_qiov, cluster_data,
 496                     512 * cur_nr_sectors);
 497             }
 498
 499             BLKDBG_EVENT(bs->file, BLKDBG_READ_AIO);
 500             qemu_co_mutex_unlock(&s->lock);
 501             ret = bdrv_co_readv(bs->file,
 502                                 (cluster_offset >> 9) + index_in_cluster,
 503                                 cur_nr_sectors, &hd_qiov);
 504             qemu_co_mutex_lock(&s->lock);
 505             if (ret < 0) {
 506                 goto fail;
 507             }
 508             if (s->crypt_method) {
 509                 qcow2_encrypt_sectors(s, sector_num,  cluster_data,
 510                     cluster_data, cur_nr_sectors, 0, &s->aes_decrypt_key);
 511                 qemu_iovec_reset(&hd_qiov);
 512                 qemu_iovec_copy(&hd_qiov, qiov, bytes_done,
 513                     cur_nr_sectors * 512);
 514                 qemu_iovec_from_buffer(&hd_qiov, cluster_data,
 515                     512 * cur_nr_sectors);
 516             }
 517         }
 518
 519         remaining_sectors -= cur_nr_sectors;
 520         sector_num += cur_nr_sectors;
 521         bytes_done += cur_nr_sectors * 512;
 522     }
 523     ret = 0;
 524
 525 fail:
 526     qemu_co_mutex_unlock(&s->lock);
 527
 528     qemu_iovec_destroy(&hd_qiov);
 529     qemu_vfree(cluster_data);
 530
 531     return ret;
 532 }
 533
 534 static void run_dependent_requests(BDRVQcowState *s, QCowL2Meta *m)
 535 {
 536     /* Take the request off the list of running requests */
 537     if (m->nb_clusters != 0) {
 538         QLIST_REMOVE(m, next_in_flight);
 539     }
 540
 541     /* Restart all dependent requests */
 542     if (!qemu_co_queue_empty(&m->dependent_requests)) {
 543         qemu_co_mutex_unlock(&s->lock);
 544         qemu_co_queue_restart_all(&m->dependent_requests);
 545         qemu_co_mutex_lock(&s->lock);
 546     }
 547 }
 548
 549 static coroutine_fn int qcow2_co_writev(BlockDriverState *bs,
 550                            int64_t sector_num,
 551                            int remaining_sectors,
 552                            QEMUIOVector *qiov)
 553 {
 554     BDRVQcowState *s = bs->opaque;
 555     int index_in_cluster;
 556     int n_end;
 557     int ret;
 558     int cur_nr_sectors; /* number of sectors in current iteration */
 559     uint64_t cluster_offset;
 560     QEMUIOVector hd_qiov;
 561     uint64_t bytes_done = 0;
 562     uint8_t *cluster_data = NULL;
 563     QCowL2Meta l2meta = {
 564         .nb_clusters = 0,
 565     };
 566
 567     qemu_co_queue_init(&l2meta.dependent_requests);
 568
 569     qemu_iovec_init(&hd_qiov, qiov->niov);
 570
 571     s->cluster_cache_offset = -1; /* disable compressed cache */
 572
 573     qemu_co_mutex_lock(&s->lock);
 574
 575     while (remaining_sectors != 0) {
 576
 577         index_in_cluster = sector_num & (s->cluster_sectors - 1);
 578         n_end = index_in_cluster + remaining_sectors;
 579         if (s->crypt_method &&
 580             n_end > QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors) {
 581             n_end = QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors;
 582         }
 583
 584         ret = qcow2_alloc_cluster_offset(bs, sector_num << 9,
 585             index_in_cluster, n_end, &cur_nr_sectors, &l2meta);
 586         if (ret < 0) {
 587             goto fail;
 588         }
 589
 590         cluster_offset = l2meta.cluster_offset;
 591         assert((cluster_offset & 511) == 0);
 592
 593         qemu_iovec_reset(&hd_qiov);
 594         qemu_iovec_copy(&hd_qiov, qiov, bytes_done,
 595             cur_nr_sectors * 512);
 596
 597         if (s->crypt_method) {
 598             if (!cluster_data) {
 599                 cluster_data = qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS *
 600                                                  s->cluster_size);
 601             }
 602
 603             assert(hd_qiov.size <=
 604                    QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
 605             qemu_iovec_to_buffer(&hd_qiov, cluster_data);
 606
 607             qcow2_encrypt_sectors(s, sector_num, cluster_data,
 608                 cluster_data, cur_nr_sectors, 1, &s->aes_encrypt_key);
 609
 610             qemu_iovec_reset(&hd_qiov);
 611             qemu_iovec_add(&hd_qiov, cluster_data,
 612                 cur_nr_sectors * 512);
 613         }
 614
 615         BLKDBG_EVENT(bs->file, BLKDBG_WRITE_AIO);
 616         qemu_co_mutex_unlock(&s->lock);
 617         ret = bdrv_co_writev(bs->file,
 618                              (cluster_offset >> 9) + index_in_cluster,
 619                              cur_nr_sectors, &hd_qiov);
 620         qemu_co_mutex_lock(&s->lock);
 621         if (ret < 0) {
 622             goto fail;
 623         }
 624
 625         ret = qcow2_alloc_cluster_link_l2(bs, &l2meta);
 626         if (ret < 0) {
 627             goto fail;
 628         }
 629
 630         run_dependent_requests(s, &l2meta);
 631
 632         remaining_sectors -= cur_nr_sectors;
 633         sector_num += cur_nr_sectors;
 634         bytes_done += cur_nr_sectors * 512;
 635     }
 636     ret = 0;
 637
 638 fail:
 639     run_dependent_requests(s, &l2meta);
 640
 641     qemu_co_mutex_unlock(&s->lock);
 642
 643     qemu_iovec_destroy(&hd_qiov);
 644     qemu_vfree(cluster_data);
 645
 646     return ret;
 647 }
 648
 649 static void qcow2_close(BlockDriverState *bs)
 650 {
 651     BDRVQcowState *s = bs->opaque;
 652     g_free(s->l1_table);
 653
 654     qcow2_cache_flush(bs, s->l2_table_cache);
 655     qcow2_cache_flush(bs, s->refcount_block_cache);
 656
 657     qcow2_cache_destroy(bs, s->l2_table_cache);
 658     qcow2_cache_destroy(bs, s->refcount_block_cache);
 659
 660     cleanup_unknown_header_ext(bs);
 661     g_free(s->cluster_cache);
 662     qemu_vfree(s->cluster_data);
 663     qcow2_refcount_close(bs);
 664     qcow2_free_snapshots(bs);
 665 }
 666
 667 static void qcow2_invalidate_cache(BlockDriverState *bs)
 668 {
 669     BDRVQcowState *s = bs->opaque;
 670     int flags = s->flags;
 671     AES_KEY aes_encrypt_key;
 672     AES_KEY aes_decrypt_key;
 673     uint32_t crypt_method = 0;
 674
 675     /*
 676      * Backing files are read-only which makes all of their metadata immutable,
 677      * that means we don't have to worry about reopening them here.
 678      */
 679
 680     if (s->crypt_method) {
 681         crypt_method = s->crypt_method;
 682         memcpy(&aes_encrypt_key, &s->aes_encrypt_key, sizeof(aes_encrypt_key));
 683         memcpy(&aes_decrypt_key, &s->aes_decrypt_key, sizeof(aes_decrypt_key));
 684     }
 685
 686     qcow2_close(bs);
 687
 688     memset(s, 0, sizeof(BDRVQcowState));
 689     qcow2_open(bs, flags);
 690
 691     if (crypt_method) {
 692         s->crypt_method = crypt_method;
 693         memcpy(&s->aes_encrypt_key, &aes_encrypt_key, sizeof(aes_encrypt_key));
 694         memcpy(&s->aes_decrypt_key, &aes_decrypt_key, sizeof(aes_decrypt_key));
 695     }
 696 }
 697
 698 static size_t header_ext_add(char *buf, uint32_t magic, const void *s,
 699     size_t len, size_t buflen)
 700 {
 701     QCowExtension *ext_backing_fmt = (QCowExtension*) buf;
 702     size_t ext_len = sizeof(QCowExtension) + ((len + 7) & ~7);
 703
 704     if (buflen < ext_len) {
 705         return -ENOSPC;
 706     }
 707
 708     *ext_backing_fmt = (QCowExtension) {
 709         .magic  = cpu_to_be32(magic),
 710         .len    = cpu_to_be32(len),
 711     };
 712     memcpy(buf + sizeof(QCowExtension), s, len);
 713
 714     return ext_len;
 715 }
 716
 717 /*
 718  * Updates the qcow2 header, including the variable length parts of it, i.e.
 719  * the backing file name and all extensions. qcow2 was not designed to allow
 720  * such changes, so if we run out of space (we can only use the first cluster)
 721  * this function may fail.
 722  *
 723  * Returns 0 on success, -errno in error cases.
 724  */
 725 int qcow2_update_header(BlockDriverState *bs)
 726 {
 727     BDRVQcowState *s = bs->opaque;
 728     QCowHeader *header;
 729     char *buf;
 730     size_t buflen = s->cluster_size;
 731     int ret;
 732     uint64_t total_size;
 733     uint32_t refcount_table_clusters;
 734     Qcow2UnknownHeaderExtension *uext;
 735
 736     buf = qemu_blockalign(bs, buflen);
 737     memset(buf, 0, s->cluster_size);
 738
 739     /* Header structure */
 740     header = (QCowHeader*) buf;
 741
 742     if (buflen < sizeof(*header)) {
 743         ret = -ENOSPC;
 744         goto fail;
 745     }
 746
 747     total_size = bs->total_sectors * BDRV_SECTOR_SIZE;
 748     refcount_table_clusters = s->refcount_table_size >> (s->cluster_bits - 3);
 749
 750     *header = (QCowHeader) {
 751         .magic                  = cpu_to_be32(QCOW_MAGIC),
 752         .version                = cpu_to_be32(QCOW_VERSION),
 753         .backing_file_offset    = 0,
 754         .backing_file_size      = 0,
 755         .cluster_bits           = cpu_to_be32(s->cluster_bits),
 756         .size                   = cpu_to_be64(total_size),
 757         .crypt_method           = cpu_to_be32(s->crypt_method_header),
 758         .l1_size                = cpu_to_be32(s->l1_size),
 759         .l1_table_offset        = cpu_to_be64(s->l1_table_offset),
 760         .refcount_table_offset  = cpu_to_be64(s->refcount_table_offset),
 761         .refcount_table_clusters = cpu_to_be32(refcount_table_clusters),
 762         .nb_snapshots           = cpu_to_be32(s->nb_snapshots),
 763         .snapshots_offset       = cpu_to_be64(s->snapshots_offset),
 764     };
 765
 766     buf += sizeof(*header);
 767     buflen -= sizeof(*header);
 768
 769     /* Backing file format header extension */
 770     if (*bs->backing_format) {
 771         ret = header_ext_add(buf, QCOW2_EXT_MAGIC_BACKING_FORMAT,
 772                              bs->backing_format, strlen(bs->backing_format),
 773                              buflen);
 774         if (ret < 0) {
 775             goto fail;
 776         }
 777
 778         buf += ret;
 779         buflen -= ret;
 780     }
 781
 782     /* Keep unknown header extensions */
 783     QLIST_FOREACH(uext, &s->unknown_header_ext, next) {
 784         ret = header_ext_add(buf, uext->magic, uext->data, uext->len, buflen);
 785         if (ret < 0) {
 786             goto fail;
 787         }
 788
 789         buf += ret;
 790         buflen -= ret;
 791     }
 792
 793     /* End of header extensions */
 794     ret = header_ext_add(buf, QCOW2_EXT_MAGIC_END, NULL, 0, buflen);
 795     if (ret < 0) {
 796         goto fail;
 797     }
 798
 799     buf += ret;
 800     buflen -= ret;
 801
 802     /* Backing file name */
 803     if (*bs->backing_file) {
 804         size_t backing_file_len = strlen(bs->backing_file);
 805
 806         if (buflen < backing_file_len) {
 807             ret = -ENOSPC;
 808             goto fail;
 809         }
 810
 811         strncpy(buf, bs->backing_file, buflen);
 812
 813         header->backing_file_offset = cpu_to_be64(buf - ((char*) header));
 814         header->backing_file_size   = cpu_to_be32(backing_file_len);
 815     }
 816
 817     /* Write the new header */
 818     ret = bdrv_pwrite(bs->file, 0, header, s->cluster_size);
 819     if (ret < 0) {
 820         goto fail;
 821     }
 822
 823     ret = 0;
 824 fail:
 825     qemu_vfree(header);
 826     return ret;
 827 }
 828
 829 static int qcow2_change_backing_file(BlockDriverState *bs,
 830     const char *backing_file, const char *backing_fmt)
 831 {
 832     /* Backing file format doesn't make sense without a backing file */
 833     if (backing_fmt && !backing_file) {
 834         return -EINVAL;
 835     }
 836
 837     pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: "");
 838     pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: "");
 839
 840     return qcow2_update_header(bs);
 841 }
 842
 843 static int preallocate(BlockDriverState *bs)
 844 {
 845     uint64_t nb_sectors;
 846     uint64_t offset;
 847     int num;
 848     int ret;
 849     QCowL2Meta meta;
 850
 851     nb_sectors = bdrv_getlength(bs) >> 9;
 852     offset = 0;
 853     qemu_co_queue_init(&meta.dependent_requests);
 854     meta.cluster_offset = 0;
 855
 856     while (nb_sectors) {
 857         num = MIN(nb_sectors, INT_MAX >> 9);
 858         ret = qcow2_alloc_cluster_offset(bs, offset, 0, num, &num, &meta);
 859         if (ret < 0) {
 860             return ret;
 861         }
 862
 863         ret = qcow2_alloc_cluster_link_l2(bs, &meta);
 864         if (ret < 0) {
 865             qcow2_free_any_clusters(bs, meta.cluster_offset, meta.nb_clusters);
 866             return ret;
 867         }
 868
 869         /* There are no dependent requests, but we need to remove our request
 870          * from the list of in-flight requests */
 871         run_dependent_requests(bs->opaque, &meta);
 872
 873         /* TODO Preallocate data if requested */
 874
 875         nb_sectors -= num;
 876         offset += num << 9;
 877     }
 878
 879     /*
 880      * It is expected that the image file is large enough to actually contain
 881      * all of the allocated clusters (otherwise we get failing reads after
 882      * EOF). Extend the image to the last allocated sector.
 883      */
 884     if (meta.cluster_offset != 0) {
 885         uint8_t buf[512];
 886         memset(buf, 0, 512);
 887         ret = bdrv_write(bs->file, (meta.cluster_offset >> 9) + num - 1, buf, 1);
 888         if (ret < 0) {
 889             return ret;
 890         }
 891     }
 892
 893     return 0;
 894 }
 895
 896 static int qcow2_create2(const char *filename, int64_t total_size,
 897                          const char *backing_file, const char *backing_format,
 898                          int flags, size_t cluster_size, int prealloc,
 899                          QEMUOptionParameter *options)
 900 {
 901     /* Calculate cluster_bits */
 902     int cluster_bits;
 903     cluster_bits = ffs(cluster_size) - 1;
 904     if (cluster_bits < MIN_CLUSTER_BITS || cluster_bits > MAX_CLUSTER_BITS ||
 905         (1 << cluster_bits) != cluster_size)
 906     {
 907         error_report(
 908             "Cluster size must be a power of two between %d and %dk",
 909             1 << MIN_CLUSTER_BITS, 1 << (MAX_CLUSTER_BITS - 10));
 910         return -EINVAL;
 911     }
 912
 913     /*
 914      * Open the image file and write a minimal qcow2 header.
 915      *
 916      * We keep things simple and start with a zero-sized image. We also
 917      * do without refcount blocks or a L1 table for now. We'll fix the
 918      * inconsistency later.
 919      *
 920      * We do need a refcount table because growing the refcount table means
 921      * allocating two new refcount blocks - the seconds of which would be at
 922      * 2 GB for 64k clusters, and we don't want to have a 2 GB initial file
 923      * size for any qcow2 image.
 924      */
 925     BlockDriverState* bs;
 926     QCowHeader header;
 927     uint8_t* refcount_table;
 928     int ret;
 929
 930     ret = bdrv_create_file(filename, options);
 931     if (ret < 0) {
 932         return ret;
 933     }
 934
 935     ret = bdrv_file_open(&bs, filename, BDRV_O_RDWR);
 936     if (ret < 0) {
 937         return ret;
 938     }
 939
 940     /* Write the header */
 941     memset(&header, 0, sizeof(header));
 942     header.magic = cpu_to_be32(QCOW_MAGIC);
 943     header.version = cpu_to_be32(QCOW_VERSION);
 944     header.cluster_bits = cpu_to_be32(cluster_bits);
 945     header.size = cpu_to_be64(0);
 946     header.l1_table_offset = cpu_to_be64(0);
 947     header.l1_size = cpu_to_be32(0);
 948     header.refcount_table_offset = cpu_to_be64(cluster_size);
 949     header.refcount_table_clusters = cpu_to_be32(1);
 950
 951     if (flags & BLOCK_FLAG_ENCRYPT) {
 952         header.crypt_method = cpu_to_be32(QCOW_CRYPT_AES);
 953     } else {
 954         header.crypt_method = cpu_to_be32(QCOW_CRYPT_NONE);
 955     }
 956
 957     ret = bdrv_pwrite(bs, 0, &header, sizeof(header));
 958     if (ret < 0) {
 959         goto out;
 960     }
 961
 962     /* Write an empty refcount table */
 963     refcount_table = g_malloc0(cluster_size);
 964     ret = bdrv_pwrite(bs, cluster_size, refcount_table, cluster_size);
 965     g_free(refcount_table);
 966
 967     if (ret < 0) {
 968         goto out;
 969     }
 970
 971     bdrv_close(bs);
 972
 973     /*
 974      * And now open the image and make it consistent first (i.e. increase the
 975      * refcount of the cluster that is occupied by the header and the refcount
 976      * table)
 977      */
 978     BlockDriver* drv = bdrv_find_format("qcow2");
 979     assert(drv != NULL);
 980     ret = bdrv_open(bs, filename,
 981         BDRV_O_RDWR | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH, drv);
 982     if (ret < 0) {
 983         goto out;
 984     }
 985
 986     ret = qcow2_alloc_clusters(bs, 2 * cluster_size);
 987     if (ret < 0) {
 988         goto out;
 989
 990     } else if (ret != 0) {
 991         error_report("Huh, first cluster in empty image is already in use?");
 992         abort();
 993     }
 994
 995     /* Okay, now that we have a valid image, let's give it the right size */
 996     ret = bdrv_truncate(bs, total_size * BDRV_SECTOR_SIZE);
 997     if (ret < 0) {
 998         goto out;
 999     }
1000
1001     /* Want a backing file? There you go.*/
1002     if (backing_file) {
1003         ret = bdrv_change_backing_file(bs, backing_file, backing_format);
1004         if (ret < 0) {
1005             goto out;
1006         }
1007     }
1008
1009     /* And if we're supposed to preallocate metadata, do that now */
1010     if (prealloc) {
1011         ret = preallocate(bs);
1012         if (ret < 0) {
1013             goto out;
1014         }
1015     }
1016
1017     ret = 0;
1018 out:
1019     bdrv_delete(bs);
1020     return ret;
1021 }
1022
1023 static int qcow2_create(const char *filename, QEMUOptionParameter *options)
1024 {
1025     const char *backing_file = NULL;
1026     const char *backing_fmt = NULL;
1027     uint64_t sectors = 0;
1028     int flags = 0;
1029     size_t cluster_size = DEFAULT_CLUSTER_SIZE;
1030     int prealloc = 0;
1031
1032     /* Read out options */
1033     while (options && options->name) {
1034         if (!strcmp(options->name, BLOCK_OPT_SIZE)) {
1035             sectors = options->value.n / 512;
1036         } else if (!strcmp(options->name, BLOCK_OPT_BACKING_FILE)) {
1037             backing_file = options->value.s;
1038         } else if (!strcmp(options->name, BLOCK_OPT_BACKING_FMT)) {
1039             backing_fmt = options->value.s;
1040         } else if (!strcmp(options->name, BLOCK_OPT_ENCRYPT)) {
1041             flags |= options->value.n ? BLOCK_FLAG_ENCRYPT : 0;
1042         } else if (!strcmp(options->name, BLOCK_OPT_CLUSTER_SIZE)) {
1043             if (options->value.n) {
1044                 cluster_size = options->value.n;
1045             }
1046         } else if (!strcmp(options->name, BLOCK_OPT_PREALLOC)) {
1047             if (!options->value.s || !strcmp(options->value.s, "off")) {
1048                 prealloc = 0;
1049             } else if (!strcmp(options->value.s, "metadata")) {
1050                 prealloc = 1;
1051             } else {
1052                 fprintf(stderr, "Invalid preallocation mode: '%s'\n",
1053                     options->value.s);
1054                 return -EINVAL;
1055             }
1056         }
1057         options++;
1058     }
1059
1060     if (backing_file && prealloc) {
1061         fprintf(stderr, "Backing file and preallocation cannot be used at "
1062             "the same time\n");
1063         return -EINVAL;
1064     }
1065
1066     return qcow2_create2(filename, sectors, backing_file, backing_fmt, flags,
1067                          cluster_size, prealloc, options);
1068 }
1069
1070 static int qcow2_make_empty(BlockDriverState *bs)
1071 {
1072 #if 0
1073     /* XXX: not correct */
1074     BDRVQcowState *s = bs->opaque;
1075     uint32_t l1_length = s->l1_size * sizeof(uint64_t);
1076     int ret;
1077
1078     memset(s->l1_table, 0, l1_length);
1079     if (bdrv_pwrite(bs->file, s->l1_table_offset, s->l1_table, l1_length) < 0)
1080         return -1;
1081     ret = bdrv_truncate(bs->file, s->l1_table_offset + l1_length);
1082     if (ret < 0)
1083         return ret;
1084
1085     l2_cache_reset(bs);
1086 #endif
1087     return 0;
1088 }
1089
1090 static coroutine_fn int qcow2_co_discard(BlockDriverState *bs,
1091     int64_t sector_num, int nb_sectors)
1092 {
1093     int ret;
1094     BDRVQcowState *s = bs->opaque;
1095
1096     qemu_co_mutex_lock(&s->lock);
1097     ret = qcow2_discard_clusters(bs, sector_num << BDRV_SECTOR_BITS,
1098         nb_sectors);
1099     qemu_co_mutex_unlock(&s->lock);
1100     return ret;
1101 }
1102
1103 static int qcow2_truncate(BlockDriverState *bs, int64_t offset)
1104 {
1105     BDRVQcowState *s = bs->opaque;
1106     int ret, new_l1_size;
1107
1108     if (offset & 511) {
1109         return -EINVAL;
1110     }
1111
1112     /* cannot proceed if image has snapshots */
1113     if (s->nb_snapshots) {
1114         return -ENOTSUP;
1115     }
1116
1117     /* shrinking is currently not supported */
1118     if (offset < bs->total_sectors * 512) {
1119         return -ENOTSUP;
1120     }
1121
1122     new_l1_size = size_to_l1(s, offset);
1123     ret = qcow2_grow_l1_table(bs, new_l1_size, true);
1124     if (ret < 0) {
1125         return ret;
1126     }
1127
1128     /* write updated header.size */
1129     offset = cpu_to_be64(offset);
1130     ret = bdrv_pwrite_sync(bs->file, offsetof(QCowHeader, size),
1131                            &offset, sizeof(uint64_t));
1132     if (ret < 0) {
1133         return ret;
1134     }
1135
1136     s->l1_vm_state_index = new_l1_size;
1137     return 0;
1138 }
1139
1140 /* XXX: put compressed sectors first, then all the cluster aligned
1141    tables to avoid losing bytes in alignment */
1142 static int qcow2_write_compressed(BlockDriverState *bs, int64_t sector_num,
1143                                   const uint8_t *buf, int nb_sectors)
1144 {
1145     BDRVQcowState *s = bs->opaque;
1146     z_stream strm;
1147     int ret, out_len;
1148     uint8_t *out_buf;
1149     uint64_t cluster_offset;
1150
1151     if (nb_sectors == 0) {
1152         /* align end of file to a sector boundary to ease reading with
1153            sector based I/Os */
1154         cluster_offset = bdrv_getlength(bs->file);
1155         cluster_offset = (cluster_offset + 511) & ~511;
1156         bdrv_truncate(bs->file, cluster_offset);
1157         return 0;
1158     }
1159
1160     if (nb_sectors != s->cluster_sectors)
1161         return -EINVAL;
1162
1163     out_buf = g_malloc(s->cluster_size + (s->cluster_size / 1000) + 128);
1164
1165     /* best compression, small window, no zlib header */
1166     memset(&strm, 0, sizeof(strm));
1167     ret = deflateInit2(&strm, Z_DEFAULT_COMPRESSION,
1168                        Z_DEFLATED, -12,
1169                        9, Z_DEFAULT_STRATEGY);
1170     if (ret != 0) {
1171         ret = -EINVAL;
1172         goto fail;
1173     }
1174
1175     strm.avail_in = s->cluster_size;
1176     strm.next_in = (uint8_t *)buf;
1177     strm.avail_out = s->cluster_size;
1178     strm.next_out = out_buf;
1179
1180     ret = deflate(&strm, Z_FINISH);
1181     if (ret != Z_STREAM_END && ret != Z_OK) {
1182         deflateEnd(&strm);
1183         ret = -EINVAL;
1184         goto fail;
1185     }
1186     out_len = strm.next_out - out_buf;
1187
1188     deflateEnd(&strm);
1189
1190     if (ret != Z_STREAM_END || out_len >= s->cluster_size) {
1191         /* could not compress: write normal cluster */
1192         ret = bdrv_write(bs, sector_num, buf, s->cluster_sectors);
1193         if (ret < 0) {
1194             goto fail;
1195         }
1196     } else {
1197         cluster_offset = qcow2_alloc_compressed_cluster_offset(bs,
1198             sector_num << 9, out_len);
1199         if (!cluster_offset) {
1200             ret = -EIO;
1201             goto fail;
1202         }
1203         cluster_offset &= s->cluster_offset_mask;
1204         BLKDBG_EVENT(bs->file, BLKDBG_WRITE_COMPRESSED);
1205         ret = bdrv_pwrite(bs->file, cluster_offset, out_buf, out_len);
1206         if (ret < 0) {
1207             goto fail;
1208         }
1209     }
1210
1211     ret = 0;
1212 fail:
1213     g_free(out_buf);
1214     return ret;
1215 }
1216
1217 static coroutine_fn int qcow2_co_flush_to_os(BlockDriverState *bs)
1218 {
1219     BDRVQcowState *s = bs->opaque;
1220     int ret;
1221
1222     qemu_co_mutex_lock(&s->lock);
1223     ret = qcow2_cache_flush(bs, s->l2_table_cache);
1224     if (ret < 0) {
1225         qemu_co_mutex_unlock(&s->lock);
1226         return ret;
1227     }
1228
1229     ret = qcow2_cache_flush(bs, s->refcount_block_cache);
1230     if (ret < 0) {
1231         qemu_co_mutex_unlock(&s->lock);
1232         return ret;
1233     }
1234     qemu_co_mutex_unlock(&s->lock);
1235
1236     return 0;
1237 }
1238
1239 static coroutine_fn int qcow2_co_flush_to_disk(BlockDriverState *bs)
1240 {
1241     return bdrv_co_flush(bs->file);
1242 }
1243
1244 static int64_t qcow2_vm_state_offset(BDRVQcowState *s)
1245 {
1246         return (int64_t)s->l1_vm_state_index << (s->cluster_bits + s->l2_bits);
1247 }
1248
1249 static int qcow2_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
1250 {
1251     BDRVQcowState *s = bs->opaque;
1252     bdi->cluster_size = s->cluster_size;
1253     bdi->vm_state_offset = qcow2_vm_state_offset(s);
1254     return 0;
1255 }
1256
1257
1258 static int qcow2_check(BlockDriverState *bs, BdrvCheckResult *result)
1259 {
1260     return qcow2_check_refcounts(bs, result);
1261 }
1262
1263 #if 0
1264 static void dump_refcounts(BlockDriverState *bs)
1265 {
1266     BDRVQcowState *s = bs->opaque;
1267     int64_t nb_clusters, k, k1, size;
1268     int refcount;
1269
1270     size = bdrv_getlength(bs->file);
1271     nb_clusters = size_to_clusters(s, size);
1272     for(k = 0; k < nb_clusters;) {
1273         k1 = k;
1274         refcount = get_refcount(bs, k);
1275         k++;
1276         while (k < nb_clusters && get_refcount(bs, k) == refcount)
1277             k++;
1278         printf("%" PRId64 ": refcount=%d nb=%" PRId64 "\n", k, refcount,
1279                k - k1);
1280     }
1281 }
1282 #endif
1283
1284 static int qcow2_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
1285                               int64_t pos, int size)
1286 {
1287     BDRVQcowState *s = bs->opaque;
1288     int growable = bs->growable;
1289     int ret;
1290
1291     BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_SAVE);
1292     bs->growable = 1;
1293     ret = bdrv_pwrite(bs, qcow2_vm_state_offset(s) + pos, buf, size);
1294     bs->growable = growable;
1295
1296     return ret;
1297 }
1298
1299 static int qcow2_load_vmstate(BlockDriverState *bs, uint8_t *buf,
1300                               int64_t pos, int size)
1301 {
1302     BDRVQcowState *s = bs->opaque;
1303     int growable = bs->growable;
1304     int ret;
1305
1306     BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_LOAD);
1307     bs->growable = 1;
1308     ret = bdrv_pread(bs, qcow2_vm_state_offset(s) + pos, buf, size);
1309     bs->growable = growable;
1310
1311     return ret;
1312 }
1313
1314 static QEMUOptionParameter qcow2_create_options[] = {
1315     {
1316         .name = BLOCK_OPT_SIZE,
1317         .type = OPT_SIZE,
1318         .help = "Virtual disk size"
1319     },
1320     {
1321         .name = BLOCK_OPT_BACKING_FILE,
1322         .type = OPT_STRING,
1323         .help = "File name of a base image"
1324     },
1325     {
1326         .name = BLOCK_OPT_BACKING_FMT,
1327         .type = OPT_STRING,
1328         .help = "Image format of the base image"
1329     },
1330     {
1331         .name = BLOCK_OPT_ENCRYPT,
1332         .type = OPT_FLAG,
1333         .help = "Encrypt the image"
1334     },
1335     {
1336         .name = BLOCK_OPT_CLUSTER_SIZE,
1337         .type = OPT_SIZE,
1338         .help = "qcow2 cluster size",
1339         .value = { .n = DEFAULT_CLUSTER_SIZE },
1340     },
1341     {
1342         .name = BLOCK_OPT_PREALLOC,
1343         .type = OPT_STRING,
1344         .help = "Preallocation mode (allowed values: off, metadata)"
1345     },
1346     { NULL }
1347 };
1348
1349 static BlockDriver bdrv_qcow2 = {
1350     .format_name        = "qcow2",
1351     .instance_size      = sizeof(BDRVQcowState),
1352     .bdrv_probe         = qcow2_probe,
1353     .bdrv_open          = qcow2_open,
1354     .bdrv_close         = qcow2_close,
1355     .bdrv_create        = qcow2_create,
1356     .bdrv_co_is_allocated = qcow2_co_is_allocated,
1357     .bdrv_set_key       = qcow2_set_key,
1358     .bdrv_make_empty    = qcow2_make_empty,
1359
1360     .bdrv_co_readv          = qcow2_co_readv,
1361     .bdrv_co_writev         = qcow2_co_writev,
1362     .bdrv_co_flush_to_os    = qcow2_co_flush_to_os,
1363     .bdrv_co_flush_to_disk  = qcow2_co_flush_to_disk,
1364
1365     .bdrv_co_discard        = qcow2_co_discard,
1366     .bdrv_truncate          = qcow2_truncate,
1367     .bdrv_write_compressed  = qcow2_write_compressed,
1368
1369     .bdrv_snapshot_create   = qcow2_snapshot_create,
1370     .bdrv_snapshot_goto     = qcow2_snapshot_goto,
1371     .bdrv_snapshot_delete   = qcow2_snapshot_delete,
1372     .bdrv_snapshot_list     = qcow2_snapshot_list,
1373     .bdrv_snapshot_load_tmp     = qcow2_snapshot_load_tmp,
1374     .bdrv_get_info      = qcow2_get_info,
1375
1376     .bdrv_save_vmstate    = qcow2_save_vmstate,
1377     .bdrv_load_vmstate    = qcow2_load_vmstate,
1378
1379     .bdrv_change_backing_file   = qcow2_change_backing_file,
1380
1381     .bdrv_invalidate_cache      = qcow2_invalidate_cache,
1382
1383     .create_options = qcow2_create_options,
1384     .bdrv_check = qcow2_check,
1385 };
1386
1387 static void bdrv_qcow2_init(void)
1388 {
1389     bdrv_register(&bdrv_qcow2);
1390 }
1391
1392 block_init(bdrv_qcow2_init);