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