block/qcow.c

   1 /*
   2  * Block driver for the QCOW 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/osdep.h"
  25 #include "qapi/error.h"
  26 #include "qemu-common.h"
  27 #include "qemu/error-report.h"
  28 #include "block/block_int.h"
  29 #include "sysemu/block-backend.h"
  30 #include "qemu/module.h"
  31 #include "qemu/bswap.h"
  32 #include <zlib.h>
  33 #include "qapi/qmp/qerror.h"
  34 #include "qapi/qmp/qstring.h"
  35 #include "crypto/block.h"
  36 #include "migration/blocker.h"
  37 #include "block/crypto.h"
  38
  39 /**************************************************************/
  40 /* QEMU COW block driver with compression and encryption support */
  41
  42 #define QCOW_MAGIC (('Q' << 24) | ('F' << 16) | ('I' << 8) | 0xfb)
  43 #define QCOW_VERSION 1
  44
  45 #define QCOW_CRYPT_NONE 0
  46 #define QCOW_CRYPT_AES  1
  47
  48 #define QCOW_OFLAG_COMPRESSED (1LL << 63)
  49
  50 typedef struct QCowHeader {
  51     uint32_t magic;
  52     uint32_t version;
  53     uint64_t backing_file_offset;
  54     uint32_t backing_file_size;
  55     uint32_t mtime;
  56     uint64_t size; /* in bytes */
  57     uint8_t cluster_bits;
  58     uint8_t l2_bits;
  59     uint16_t padding;
  60     uint32_t crypt_method;
  61     uint64_t l1_table_offset;
  62 } QEMU_PACKED QCowHeader;
  63
  64 #define L2_CACHE_SIZE 16
  65
  66 typedef struct BDRVQcowState {
  67     int cluster_bits;
  68     int cluster_size;
  69     int cluster_sectors;
  70     int l2_bits;
  71     int l2_size;
  72     unsigned int l1_size;
  73     uint64_t cluster_offset_mask;
  74     uint64_t l1_table_offset;
  75     uint64_t *l1_table;
  76     uint64_t *l2_cache;
  77     uint64_t l2_cache_offsets[L2_CACHE_SIZE];
  78     uint32_t l2_cache_counts[L2_CACHE_SIZE];
  79     uint8_t *cluster_cache;
  80     uint8_t *cluster_data;
  81     uint64_t cluster_cache_offset;
  82     QCryptoBlock *crypto; /* Disk encryption format driver */
  83     uint32_t crypt_method_header;
  84     CoMutex lock;
  85     Error *migration_blocker;
  86 } BDRVQcowState;
  87
  88 static int decompress_cluster(BlockDriverState *bs, uint64_t cluster_offset);
  89
  90 static int qcow_probe(const uint8_t *buf, int buf_size, const char *filename)
  91 {
  92     const QCowHeader *cow_header = (const void *)buf;
  93
  94     if (buf_size >= sizeof(QCowHeader) &&
  95         be32_to_cpu(cow_header->magic) == QCOW_MAGIC &&
  96         be32_to_cpu(cow_header->version) == QCOW_VERSION)
  97         return 100;
  98     else
  99         return 0;
 100 }
 101
 102 static QemuOptsList qcow_runtime_opts = {
 103     .name = "qcow",
 104     .head = QTAILQ_HEAD_INITIALIZER(qcow_runtime_opts.head),
 105     .desc = {
 106         BLOCK_CRYPTO_OPT_DEF_QCOW_KEY_SECRET("encrypt."),
 107         { /* end of list */ }
 108     },
 109 };
 110
 111 static int qcow_open(BlockDriverState *bs, QDict *options, int flags,
 112                      Error **errp)
 113 {
 114     BDRVQcowState *s = bs->opaque;
 115     unsigned int len, i, shift;
 116     int ret;
 117     QCowHeader header;
 118     Error *local_err = NULL;
 119     QCryptoBlockOpenOptions *crypto_opts = NULL;
 120     unsigned int cflags = 0;
 121     QDict *encryptopts = NULL;
 122     const char *encryptfmt;
 123
 124     qdict_extract_subqdict(options, &encryptopts, "encrypt.");
 125     encryptfmt = qdict_get_try_str(encryptopts, "format");
 126
 127     bs->file = bdrv_open_child(NULL, options, "file", bs, &child_file,
 128                                false, errp);
 129     if (!bs->file) {
 130         ret = -EINVAL;
 131         goto fail;
 132     }
 133
 134     ret = bdrv_pread(bs->file, 0, &header, sizeof(header));
 135     if (ret < 0) {
 136         goto fail;
 137     }
 138     be32_to_cpus(&header.magic);
 139     be32_to_cpus(&header.version);
 140     be64_to_cpus(&header.backing_file_offset);
 141     be32_to_cpus(&header.backing_file_size);
 142     be32_to_cpus(&header.mtime);
 143     be64_to_cpus(&header.size);
 144     be32_to_cpus(&header.crypt_method);
 145     be64_to_cpus(&header.l1_table_offset);
 146
 147     if (header.magic != QCOW_MAGIC) {
 148         error_setg(errp, "Image not in qcow format");
 149         ret = -EINVAL;
 150         goto fail;
 151     }
 152     if (header.version != QCOW_VERSION) {
 153         error_setg(errp, "Unsupported qcow version %" PRIu32, header.version);
 154         ret = -ENOTSUP;
 155         goto fail;
 156     }
 157
 158     if (header.size <= 1) {
 159         error_setg(errp, "Image size is too small (must be at least 2 bytes)");
 160         ret = -EINVAL;
 161         goto fail;
 162     }
 163     if (header.cluster_bits < 9 || header.cluster_bits > 16) {
 164         error_setg(errp, "Cluster size must be between 512 and 64k");
 165         ret = -EINVAL;
 166         goto fail;
 167     }
 168
 169     /* l2_bits specifies number of entries; storing a uint64_t in each entry,
 170      * so bytes = num_entries << 3. */
 171     if (header.l2_bits < 9 - 3 || header.l2_bits > 16 - 3) {
 172         error_setg(errp, "L2 table size must be between 512 and 64k");
 173         ret = -EINVAL;
 174         goto fail;
 175     }
 176
 177     s->crypt_method_header = header.crypt_method;
 178     if (s->crypt_method_header) {
 179         if (bdrv_uses_whitelist() &&
 180             s->crypt_method_header == QCOW_CRYPT_AES) {
 181             error_setg(errp,
 182                        "Use of AES-CBC encrypted qcow images is no longer "
 183                        "supported in system emulators");
 184             error_append_hint(errp,
 185                               "You can use 'qemu-img convert' to convert your "
 186                               "image to an alternative supported format, such "
 187                               "as unencrypted qcow, or raw with the LUKS "
 188                               "format instead.\n");
 189             ret = -ENOSYS;
 190             goto fail;
 191         }
 192         if (s->crypt_method_header == QCOW_CRYPT_AES) {
 193             if (encryptfmt && !g_str_equal(encryptfmt, "aes")) {
 194                 error_setg(errp,
 195                            "Header reported 'aes' encryption format but "
 196                            "options specify '%s'", encryptfmt);
 197                 ret = -EINVAL;
 198                 goto fail;
 199             }
 200             qdict_del(encryptopts, "format");
 201             crypto_opts = block_crypto_open_opts_init(
 202                 Q_CRYPTO_BLOCK_FORMAT_QCOW, encryptopts, errp);
 203             if (!crypto_opts) {
 204                 ret = -EINVAL;
 205                 goto fail;
 206             }
 207
 208             if (flags & BDRV_O_NO_IO) {
 209                 cflags |= QCRYPTO_BLOCK_OPEN_NO_IO;
 210             }
 211             s->crypto = qcrypto_block_open(crypto_opts, "encrypt.",
 212                                            NULL, NULL, cflags, errp);
 213             if (!s->crypto) {
 214                 ret = -EINVAL;
 215                 goto fail;
 216             }
 217         } else {
 218             error_setg(errp, "invalid encryption method in qcow header");
 219             ret = -EINVAL;
 220             goto fail;
 221         }
 222         bs->encrypted = true;
 223     } else {
 224         if (encryptfmt) {
 225             error_setg(errp, "No encryption in image header, but options "
 226                        "specified format '%s'", encryptfmt);
 227             ret = -EINVAL;
 228             goto fail;
 229         }
 230     }
 231     s->cluster_bits = header.cluster_bits;
 232     s->cluster_size = 1 << s->cluster_bits;
 233     s->cluster_sectors = 1 << (s->cluster_bits - 9);
 234     s->l2_bits = header.l2_bits;
 235     s->l2_size = 1 << s->l2_bits;
 236     bs->total_sectors = header.size / 512;
 237     s->cluster_offset_mask = (1LL << (63 - s->cluster_bits)) - 1;
 238
 239     /* read the level 1 table */
 240     shift = s->cluster_bits + s->l2_bits;
 241     if (header.size > UINT64_MAX - (1LL << shift)) {
 242         error_setg(errp, "Image too large");
 243         ret = -EINVAL;
 244         goto fail;
 245     } else {
 246         uint64_t l1_size = (header.size + (1LL << shift) - 1) >> shift;
 247         if (l1_size > INT_MAX / sizeof(uint64_t)) {
 248             error_setg(errp, "Image too large");
 249             ret = -EINVAL;
 250             goto fail;
 251         }
 252         s->l1_size = l1_size;
 253     }
 254
 255     s->l1_table_offset = header.l1_table_offset;
 256     s->l1_table = g_try_new(uint64_t, s->l1_size);
 257     if (s->l1_table == NULL) {
 258         error_setg(errp, "Could not allocate memory for L1 table");
 259         ret = -ENOMEM;
 260         goto fail;
 261     }
 262
 263     ret = bdrv_pread(bs->file, s->l1_table_offset, s->l1_table,
 264                s->l1_size * sizeof(uint64_t));
 265     if (ret < 0) {
 266         goto fail;
 267     }
 268
 269     for(i = 0;i < s->l1_size; i++) {
 270         be64_to_cpus(&s->l1_table[i]);
 271     }
 272
 273     /* alloc L2 cache (max. 64k * 16 * 8 = 8 MB) */
 274     s->l2_cache =
 275         qemu_try_blockalign(bs->file->bs,
 276                             s->l2_size * L2_CACHE_SIZE * sizeof(uint64_t));
 277     if (s->l2_cache == NULL) {
 278         error_setg(errp, "Could not allocate L2 table cache");
 279         ret = -ENOMEM;
 280         goto fail;
 281     }
 282     s->cluster_cache = g_malloc(s->cluster_size);
 283     s->cluster_data = g_malloc(s->cluster_size);
 284     s->cluster_cache_offset = -1;
 285
 286     /* read the backing file name */
 287     if (header.backing_file_offset != 0) {
 288         len = header.backing_file_size;
 289         if (len > 1023 || len >= sizeof(bs->backing_file)) {
 290             error_setg(errp, "Backing file name too long");
 291             ret = -EINVAL;
 292             goto fail;
 293         }
 294         ret = bdrv_pread(bs->file, header.backing_file_offset,
 295                    bs->backing_file, len);
 296         if (ret < 0) {
 297             goto fail;
 298         }
 299         bs->backing_file[len] = '\0';
 300     }
 301
 302     /* Disable migration when qcow images are used */
 303     error_setg(&s->migration_blocker, "The qcow format used by node '%s' "
 304                "does not support live migration",
 305                bdrv_get_device_or_node_name(bs));
 306     ret = migrate_add_blocker(s->migration_blocker, &local_err);
 307     if (local_err) {
 308         error_propagate(errp, local_err);
 309         error_free(s->migration_blocker);
 310         goto fail;
 311     }
 312
 313     QDECREF(encryptopts);
 314     qapi_free_QCryptoBlockOpenOptions(crypto_opts);
 315     qemu_co_mutex_init(&s->lock);
 316     return 0;
 317
 318  fail:
 319     g_free(s->l1_table);
 320     qemu_vfree(s->l2_cache);
 321     g_free(s->cluster_cache);
 322     g_free(s->cluster_data);
 323     qcrypto_block_free(s->crypto);
 324     QDECREF(encryptopts);
 325     qapi_free_QCryptoBlockOpenOptions(crypto_opts);
 326     return ret;
 327 }
 328
 329
 330 /* We have nothing to do for QCOW reopen, stubs just return
 331  * success */
 332 static int qcow_reopen_prepare(BDRVReopenState *state,
 333                                BlockReopenQueue *queue, Error **errp)
 334 {
 335     return 0;
 336 }
 337
 338
 339 /* 'allocate' is:
 340  *
 341  * 0 to not allocate.
 342  *
 343  * 1 to allocate a normal cluster (for sector indexes 'n_start' to
 344  * 'n_end')
 345  *
 346  * 2 to allocate a compressed cluster of size
 347  * 'compressed_size'. 'compressed_size' must be > 0 and <
 348  * cluster_size
 349  *
 350  * return 0 if not allocated, 1 if *result is assigned, and negative
 351  * errno on failure.
 352  */
 353 static int get_cluster_offset(BlockDriverState *bs,
 354                               uint64_t offset, int allocate,
 355                               int compressed_size,
 356                               int n_start, int n_end, uint64_t *result)
 357 {
 358     BDRVQcowState *s = bs->opaque;
 359     int min_index, i, j, l1_index, l2_index, ret;
 360     uint64_t l2_offset, *l2_table, cluster_offset, tmp;
 361     uint32_t min_count;
 362     int new_l2_table;
 363
 364     *result = 0;
 365     l1_index = offset >> (s->l2_bits + s->cluster_bits);
 366     l2_offset = s->l1_table[l1_index];
 367     new_l2_table = 0;
 368     if (!l2_offset) {
 369         if (!allocate)
 370             return 0;
 371         /* allocate a new l2 entry */
 372         l2_offset = bdrv_getlength(bs->file->bs);
 373         /* round to cluster size */
 374         l2_offset = (l2_offset + s->cluster_size - 1) & ~(s->cluster_size - 1);
 375         /* update the L1 entry */
 376         s->l1_table[l1_index] = l2_offset;
 377         tmp = cpu_to_be64(l2_offset);
 378         ret = bdrv_pwrite_sync(bs->file,
 379                                s->l1_table_offset + l1_index * sizeof(tmp),
 380                                &tmp, sizeof(tmp));
 381         if (ret < 0) {
 382             return ret;
 383         }
 384         new_l2_table = 1;
 385     }
 386     for(i = 0; i < L2_CACHE_SIZE; i++) {
 387         if (l2_offset == s->l2_cache_offsets[i]) {
 388             /* increment the hit count */
 389             if (++s->l2_cache_counts[i] == 0xffffffff) {
 390                 for(j = 0; j < L2_CACHE_SIZE; j++) {
 391                     s->l2_cache_counts[j] >>= 1;
 392                 }
 393             }
 394             l2_table = s->l2_cache + (i << s->l2_bits);
 395             goto found;
 396         }
 397     }
 398     /* not found: load a new entry in the least used one */
 399     min_index = 0;
 400     min_count = 0xffffffff;
 401     for(i = 0; i < L2_CACHE_SIZE; i++) {
 402         if (s->l2_cache_counts[i] < min_count) {
 403             min_count = s->l2_cache_counts[i];
 404             min_index = i;
 405         }
 406     }
 407     l2_table = s->l2_cache + (min_index << s->l2_bits);
 408     if (new_l2_table) {
 409         memset(l2_table, 0, s->l2_size * sizeof(uint64_t));
 410         ret = bdrv_pwrite_sync(bs->file, l2_offset, l2_table,
 411                                s->l2_size * sizeof(uint64_t));
 412         if (ret < 0) {
 413             return ret;
 414         }
 415     } else {
 416         ret = bdrv_pread(bs->file, l2_offset, l2_table,
 417                          s->l2_size * sizeof(uint64_t));
 418         if (ret < 0) {
 419             return ret;
 420         }
 421     }
 422     s->l2_cache_offsets[min_index] = l2_offset;
 423     s->l2_cache_counts[min_index] = 1;
 424  found:
 425     l2_index = (offset >> s->cluster_bits) & (s->l2_size - 1);
 426     cluster_offset = be64_to_cpu(l2_table[l2_index]);
 427     if (!cluster_offset ||
 428         ((cluster_offset & QCOW_OFLAG_COMPRESSED) && allocate == 1)) {
 429         if (!allocate)
 430             return 0;
 431         /* allocate a new cluster */
 432         if ((cluster_offset & QCOW_OFLAG_COMPRESSED) &&
 433             (n_end - n_start) < s->cluster_sectors) {
 434             /* if the cluster is already compressed, we must
 435                decompress it in the case it is not completely
 436                overwritten */
 437             if (decompress_cluster(bs, cluster_offset) < 0) {
 438                 return -EIO;
 439             }
 440             cluster_offset = bdrv_getlength(bs->file->bs);
 441             cluster_offset = (cluster_offset + s->cluster_size - 1) &
 442                 ~(s->cluster_size - 1);
 443             /* write the cluster content */
 444             ret = bdrv_pwrite(bs->file, cluster_offset, s->cluster_cache,
 445                               s->cluster_size);
 446             if (ret < 0) {
 447                 return ret;
 448             }
 449         } else {
 450             cluster_offset = bdrv_getlength(bs->file->bs);
 451             if (allocate == 1) {
 452                 /* round to cluster size */
 453                 cluster_offset = (cluster_offset + s->cluster_size - 1) &
 454                     ~(s->cluster_size - 1);
 455                 bdrv_truncate(bs->file, cluster_offset + s->cluster_size,
 456                               PREALLOC_MODE_OFF, NULL);
 457                 /* if encrypted, we must initialize the cluster
 458                    content which won't be written */
 459                 if (bs->encrypted &&
 460                     (n_end - n_start) < s->cluster_sectors) {
 461                     uint64_t start_sect;
 462                     assert(s->crypto);
 463                     start_sect = (offset & ~(s->cluster_size - 1)) >> 9;
 464                     for(i = 0; i < s->cluster_sectors; i++) {
 465                         if (i < n_start || i >= n_end) {
 466                             memset(s->cluster_data, 0x00, 512);
 467                             if (qcrypto_block_encrypt(s->crypto, start_sect + i,
 468                                                       s->cluster_data,
 469                                                       BDRV_SECTOR_SIZE,
 470                                                       NULL) < 0) {
 471                                 return -EIO;
 472                             }
 473                             ret = bdrv_pwrite(bs->file,
 474                                               cluster_offset + i * 512,
 475                                               s->cluster_data, 512);
 476                             if (ret < 0) {
 477                                 return ret;
 478                             }
 479                         }
 480                     }
 481                 }
 482             } else if (allocate == 2) {
 483                 cluster_offset |= QCOW_OFLAG_COMPRESSED |
 484                     (uint64_t)compressed_size << (63 - s->cluster_bits);
 485             }
 486         }
 487         /* update L2 table */
 488         tmp = cpu_to_be64(cluster_offset);
 489         l2_table[l2_index] = tmp;
 490         ret = bdrv_pwrite_sync(bs->file, l2_offset + l2_index * sizeof(tmp),
 491                                &tmp, sizeof(tmp));
 492         if (ret < 0) {
 493             return ret;
 494         }
 495     }
 496     *result = cluster_offset;
 497     return 1;
 498 }
 499
 500 static int64_t coroutine_fn qcow_co_get_block_status(BlockDriverState *bs,
 501         int64_t sector_num, int nb_sectors, int *pnum, BlockDriverState **file)
 502 {
 503     BDRVQcowState *s = bs->opaque;
 504     int index_in_cluster, n, ret;
 505     uint64_t cluster_offset;
 506
 507     qemu_co_mutex_lock(&s->lock);
 508     ret = get_cluster_offset(bs, sector_num << 9, 0, 0, 0, 0, &cluster_offset);
 509     qemu_co_mutex_unlock(&s->lock);
 510     if (ret < 0) {
 511         return ret;
 512     }
 513     index_in_cluster = sector_num & (s->cluster_sectors - 1);
 514     n = s->cluster_sectors - index_in_cluster;
 515     if (n > nb_sectors)
 516         n = nb_sectors;
 517     *pnum = n;
 518     if (!cluster_offset) {
 519         return 0;
 520     }
 521     if ((cluster_offset & QCOW_OFLAG_COMPRESSED) || s->crypto) {
 522         return BDRV_BLOCK_DATA;
 523     }
 524     cluster_offset |= (index_in_cluster << BDRV_SECTOR_BITS);
 525     *file = bs->file->bs;
 526     return BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID | cluster_offset;
 527 }
 528
 529 static int decompress_buffer(uint8_t *out_buf, int out_buf_size,
 530                              const uint8_t *buf, int buf_size)
 531 {
 532     z_stream strm1, *strm = &strm1;
 533     int ret, out_len;
 534
 535     memset(strm, 0, sizeof(*strm));
 536
 537     strm->next_in = (uint8_t *)buf;
 538     strm->avail_in = buf_size;
 539     strm->next_out = out_buf;
 540     strm->avail_out = out_buf_size;
 541
 542     ret = inflateInit2(strm, -12);
 543     if (ret != Z_OK)
 544         return -1;
 545     ret = inflate(strm, Z_FINISH);
 546     out_len = strm->next_out - out_buf;
 547     if ((ret != Z_STREAM_END && ret != Z_BUF_ERROR) ||
 548         out_len != out_buf_size) {
 549         inflateEnd(strm);
 550         return -1;
 551     }
 552     inflateEnd(strm);
 553     return 0;
 554 }
 555
 556 static int decompress_cluster(BlockDriverState *bs, uint64_t cluster_offset)
 557 {
 558     BDRVQcowState *s = bs->opaque;
 559     int ret, csize;
 560     uint64_t coffset;
 561
 562     coffset = cluster_offset & s->cluster_offset_mask;
 563     if (s->cluster_cache_offset != coffset) {
 564         csize = cluster_offset >> (63 - s->cluster_bits);
 565         csize &= (s->cluster_size - 1);
 566         ret = bdrv_pread(bs->file, coffset, s->cluster_data, csize);
 567         if (ret != csize)
 568             return -1;
 569         if (decompress_buffer(s->cluster_cache, s->cluster_size,
 570                               s->cluster_data, csize) < 0) {
 571             return -1;
 572         }
 573         s->cluster_cache_offset = coffset;
 574     }
 575     return 0;
 576 }
 577
 578 static coroutine_fn int qcow_co_readv(BlockDriverState *bs, int64_t sector_num,
 579                          int nb_sectors, QEMUIOVector *qiov)
 580 {
 581     BDRVQcowState *s = bs->opaque;
 582     int index_in_cluster;
 583     int ret = 0, n;
 584     uint64_t cluster_offset;
 585     struct iovec hd_iov;
 586     QEMUIOVector hd_qiov;
 587     uint8_t *buf;
 588     void *orig_buf;
 589
 590     if (qiov->niov > 1) {
 591         buf = orig_buf = qemu_try_blockalign(bs, qiov->size);
 592         if (buf == NULL) {
 593             return -ENOMEM;
 594         }
 595     } else {
 596         orig_buf = NULL;
 597         buf = (uint8_t *)qiov->iov->iov_base;
 598     }
 599
 600     qemu_co_mutex_lock(&s->lock);
 601
 602     while (nb_sectors != 0) {
 603         /* prepare next request */
 604         ret = get_cluster_offset(bs, sector_num << 9,
 605                                  0, 0, 0, 0, &cluster_offset);
 606         if (ret < 0) {
 607             break;
 608         }
 609         index_in_cluster = sector_num & (s->cluster_sectors - 1);
 610         n = s->cluster_sectors - index_in_cluster;
 611         if (n > nb_sectors) {
 612             n = nb_sectors;
 613         }
 614
 615         if (!cluster_offset) {
 616             if (bs->backing) {
 617                 /* read from the base image */
 618                 hd_iov.iov_base = (void *)buf;
 619                 hd_iov.iov_len = n * 512;
 620                 qemu_iovec_init_external(&hd_qiov, &hd_iov, 1);
 621                 qemu_co_mutex_unlock(&s->lock);
 622                 ret = bdrv_co_readv(bs->backing, sector_num, n, &hd_qiov);
 623                 qemu_co_mutex_lock(&s->lock);
 624                 if (ret < 0) {
 625                     break;
 626                 }
 627             } else {
 628                 /* Note: in this case, no need to wait */
 629                 memset(buf, 0, 512 * n);
 630             }
 631         } else if (cluster_offset & QCOW_OFLAG_COMPRESSED) {
 632             /* add AIO support for compressed blocks ? */
 633             if (decompress_cluster(bs, cluster_offset) < 0) {
 634                 ret = -EIO;
 635                 break;
 636             }
 637             memcpy(buf,
 638                    s->cluster_cache + index_in_cluster * 512, 512 * n);
 639         } else {
 640             if ((cluster_offset & 511) != 0) {
 641                 ret = -EIO;
 642                 break;
 643             }
 644             hd_iov.iov_base = (void *)buf;
 645             hd_iov.iov_len = n * 512;
 646             qemu_iovec_init_external(&hd_qiov, &hd_iov, 1);
 647             qemu_co_mutex_unlock(&s->lock);
 648             ret = bdrv_co_readv(bs->file,
 649                                 (cluster_offset >> 9) + index_in_cluster,
 650                                 n, &hd_qiov);
 651             qemu_co_mutex_lock(&s->lock);
 652             if (ret < 0) {
 653                 break;
 654             }
 655             if (bs->encrypted) {
 656                 assert(s->crypto);
 657                 if (qcrypto_block_decrypt(s->crypto, sector_num, buf,
 658                                           n * BDRV_SECTOR_SIZE, NULL) < 0) {
 659                     ret = -EIO;
 660                     break;
 661                 }
 662             }
 663         }
 664         ret = 0;
 665
 666         nb_sectors -= n;
 667         sector_num += n;
 668         buf += n * 512;
 669     }
 670
 671     qemu_co_mutex_unlock(&s->lock);
 672
 673     if (qiov->niov > 1) {
 674         qemu_iovec_from_buf(qiov, 0, orig_buf, qiov->size);
 675         qemu_vfree(orig_buf);
 676     }
 677
 678     return ret;
 679 }
 680
 681 static coroutine_fn int qcow_co_writev(BlockDriverState *bs, int64_t sector_num,
 682                           int nb_sectors, QEMUIOVector *qiov)
 683 {
 684     BDRVQcowState *s = bs->opaque;
 685     int index_in_cluster;
 686     uint64_t cluster_offset;
 687     int ret = 0, n;
 688     struct iovec hd_iov;
 689     QEMUIOVector hd_qiov;
 690     uint8_t *buf;
 691     void *orig_buf;
 692
 693     s->cluster_cache_offset = -1; /* disable compressed cache */
 694
 695     /* We must always copy the iov when encrypting, so we
 696      * don't modify the original data buffer during encryption */
 697     if (bs->encrypted || qiov->niov > 1) {
 698         buf = orig_buf = qemu_try_blockalign(bs, qiov->size);
 699         if (buf == NULL) {
 700             return -ENOMEM;
 701         }
 702         qemu_iovec_to_buf(qiov, 0, buf, qiov->size);
 703     } else {
 704         orig_buf = NULL;
 705         buf = (uint8_t *)qiov->iov->iov_base;
 706     }
 707
 708     qemu_co_mutex_lock(&s->lock);
 709
 710     while (nb_sectors != 0) {
 711
 712         index_in_cluster = sector_num & (s->cluster_sectors - 1);
 713         n = s->cluster_sectors - index_in_cluster;
 714         if (n > nb_sectors) {
 715             n = nb_sectors;
 716         }
 717         ret = get_cluster_offset(bs, sector_num << 9, 1, 0,
 718                                  index_in_cluster,
 719                                  index_in_cluster + n, &cluster_offset);
 720         if (ret < 0) {
 721             break;
 722         }
 723         if (!cluster_offset || (cluster_offset & 511) != 0) {
 724             ret = -EIO;
 725             break;
 726         }
 727         if (bs->encrypted) {
 728             assert(s->crypto);
 729             if (qcrypto_block_encrypt(s->crypto, sector_num, buf,
 730                                       n * BDRV_SECTOR_SIZE, NULL) < 0) {
 731                 ret = -EIO;
 732                 break;
 733             }
 734         }
 735
 736         hd_iov.iov_base = (void *)buf;
 737         hd_iov.iov_len = n * 512;
 738         qemu_iovec_init_external(&hd_qiov, &hd_iov, 1);
 739         qemu_co_mutex_unlock(&s->lock);
 740         ret = bdrv_co_writev(bs->file,
 741                              (cluster_offset >> 9) + index_in_cluster,
 742                              n, &hd_qiov);
 743         qemu_co_mutex_lock(&s->lock);
 744         if (ret < 0) {
 745             break;
 746         }
 747         ret = 0;
 748
 749         nb_sectors -= n;
 750         sector_num += n;
 751         buf += n * 512;
 752     }
 753     qemu_co_mutex_unlock(&s->lock);
 754
 755     qemu_vfree(orig_buf);
 756
 757     return ret;
 758 }
 759
 760 static void qcow_close(BlockDriverState *bs)
 761 {
 762     BDRVQcowState *s = bs->opaque;
 763
 764     qcrypto_block_free(s->crypto);
 765     s->crypto = NULL;
 766     g_free(s->l1_table);
 767     qemu_vfree(s->l2_cache);
 768     g_free(s->cluster_cache);
 769     g_free(s->cluster_data);
 770
 771     migrate_del_blocker(s->migration_blocker);
 772     error_free(s->migration_blocker);
 773 }
 774
 775 static int qcow_create(const char *filename, QemuOpts *opts, Error **errp)
 776 {
 777     int header_size, backing_filename_len, l1_size, shift, i;
 778     QCowHeader header;
 779     uint8_t *tmp;
 780     int64_t total_size = 0;
 781     char *backing_file = NULL;
 782     Error *local_err = NULL;
 783     int ret;
 784     BlockBackend *qcow_blk;
 785     char *encryptfmt = NULL;
 786     QDict *options;
 787     QDict *encryptopts = NULL;
 788     QCryptoBlockCreateOptions *crypto_opts = NULL;
 789     QCryptoBlock *crypto = NULL;
 790
 791     /* Read out options */
 792     total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
 793                           BDRV_SECTOR_SIZE);
 794     if (total_size == 0) {
 795         error_setg(errp, "Image size is too small, cannot be zero length");
 796         ret = -EINVAL;
 797         goto cleanup;
 798     }
 799
 800     backing_file = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FILE);
 801     encryptfmt = qemu_opt_get_del(opts, BLOCK_OPT_ENCRYPT_FORMAT);
 802     if (encryptfmt) {
 803         if (qemu_opt_get(opts, BLOCK_OPT_ENCRYPT)) {
 804             error_setg(errp, "Options " BLOCK_OPT_ENCRYPT " and "
 805                        BLOCK_OPT_ENCRYPT_FORMAT " are mutually exclusive");
 806             ret = -EINVAL;
 807             goto cleanup;
 808         }
 809     } else if (qemu_opt_get_bool_del(opts, BLOCK_OPT_ENCRYPT, false)) {
 810         encryptfmt = g_strdup("aes");
 811     }
 812
 813     ret = bdrv_create_file(filename, opts, &local_err);
 814     if (ret < 0) {
 815         error_propagate(errp, local_err);
 816         goto cleanup;
 817     }
 818
 819     qcow_blk = blk_new_open(filename, NULL, NULL,
 820                             BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL,
 821                             &local_err);
 822     if (qcow_blk == NULL) {
 823         error_propagate(errp, local_err);
 824         ret = -EIO;
 825         goto cleanup;
 826     }
 827
 828     blk_set_allow_write_beyond_eof(qcow_blk, true);
 829
 830     ret = blk_truncate(qcow_blk, 0, PREALLOC_MODE_OFF, errp);
 831     if (ret < 0) {
 832         goto exit;
 833     }
 834
 835     memset(&header, 0, sizeof(header));
 836     header.magic = cpu_to_be32(QCOW_MAGIC);
 837     header.version = cpu_to_be32(QCOW_VERSION);
 838     header.size = cpu_to_be64(total_size);
 839     header_size = sizeof(header);
 840     backing_filename_len = 0;
 841     if (backing_file) {
 842         if (strcmp(backing_file, "fat:")) {
 843             header.backing_file_offset = cpu_to_be64(header_size);
 844             backing_filename_len = strlen(backing_file);
 845             header.backing_file_size = cpu_to_be32(backing_filename_len);
 846             header_size += backing_filename_len;
 847         } else {
 848             /* special backing file for vvfat */
 849             g_free(backing_file);
 850             backing_file = NULL;
 851         }
 852         header.cluster_bits = 9; /* 512 byte cluster to avoid copying
 853                                     unmodified sectors */
 854         header.l2_bits = 12; /* 32 KB L2 tables */
 855     } else {
 856         header.cluster_bits = 12; /* 4 KB clusters */
 857         header.l2_bits = 9; /* 4 KB L2 tables */
 858     }
 859     header_size = (header_size + 7) & ~7;
 860     shift = header.cluster_bits + header.l2_bits;
 861     l1_size = (total_size + (1LL << shift) - 1) >> shift;
 862
 863     header.l1_table_offset = cpu_to_be64(header_size);
 864
 865     options = qemu_opts_to_qdict(opts, NULL);
 866     qdict_extract_subqdict(options, &encryptopts, "encrypt.");
 867     QDECREF(options);
 868     if (encryptfmt) {
 869         if (!g_str_equal(encryptfmt, "aes")) {
 870             error_setg(errp, "Unknown encryption format '%s', expected 'aes'",
 871                        encryptfmt);
 872             ret = -EINVAL;
 873             goto exit;
 874         }
 875         header.crypt_method = cpu_to_be32(QCOW_CRYPT_AES);
 876
 877         crypto_opts = block_crypto_create_opts_init(
 878             Q_CRYPTO_BLOCK_FORMAT_QCOW, encryptopts, errp);
 879         if (!crypto_opts) {
 880             ret = -EINVAL;
 881             goto exit;
 882         }
 883
 884         crypto = qcrypto_block_create(crypto_opts, "encrypt.",
 885                                       NULL, NULL, NULL, errp);
 886         if (!crypto) {
 887             ret = -EINVAL;
 888             goto exit;
 889         }
 890     } else {
 891         header.crypt_method = cpu_to_be32(QCOW_CRYPT_NONE);
 892     }
 893
 894     /* write all the data */
 895     ret = blk_pwrite(qcow_blk, 0, &header, sizeof(header), 0);
 896     if (ret != sizeof(header)) {
 897         goto exit;
 898     }
 899
 900     if (backing_file) {
 901         ret = blk_pwrite(qcow_blk, sizeof(header),
 902                          backing_file, backing_filename_len, 0);
 903         if (ret != backing_filename_len) {
 904             goto exit;
 905         }
 906     }
 907
 908     tmp = g_malloc0(BDRV_SECTOR_SIZE);
 909     for (i = 0; i < DIV_ROUND_UP(sizeof(uint64_t) * l1_size, BDRV_SECTOR_SIZE);
 910          i++) {
 911         ret = blk_pwrite(qcow_blk, header_size + BDRV_SECTOR_SIZE * i,
 912                          tmp, BDRV_SECTOR_SIZE, 0);
 913         if (ret != BDRV_SECTOR_SIZE) {
 914             g_free(tmp);
 915             goto exit;
 916         }
 917     }
 918
 919     g_free(tmp);
 920     ret = 0;
 921 exit:
 922     blk_unref(qcow_blk);
 923 cleanup:
 924     QDECREF(encryptopts);
 925     g_free(encryptfmt);
 926     qcrypto_block_free(crypto);
 927     qapi_free_QCryptoBlockCreateOptions(crypto_opts);
 928     g_free(backing_file);
 929     return ret;
 930 }
 931
 932 static int qcow_make_empty(BlockDriverState *bs)
 933 {
 934     BDRVQcowState *s = bs->opaque;
 935     uint32_t l1_length = s->l1_size * sizeof(uint64_t);
 936     int ret;
 937
 938     memset(s->l1_table, 0, l1_length);
 939     if (bdrv_pwrite_sync(bs->file, s->l1_table_offset, s->l1_table,
 940             l1_length) < 0)
 941         return -1;
 942     ret = bdrv_truncate(bs->file, s->l1_table_offset + l1_length,
 943                         PREALLOC_MODE_OFF, NULL);
 944     if (ret < 0)
 945         return ret;
 946
 947     memset(s->l2_cache, 0, s->l2_size * L2_CACHE_SIZE * sizeof(uint64_t));
 948     memset(s->l2_cache_offsets, 0, L2_CACHE_SIZE * sizeof(uint64_t));
 949     memset(s->l2_cache_counts, 0, L2_CACHE_SIZE * sizeof(uint32_t));
 950
 951     return 0;
 952 }
 953
 954 /* XXX: put compressed sectors first, then all the cluster aligned
 955    tables to avoid losing bytes in alignment */
 956 static coroutine_fn int
 957 qcow_co_pwritev_compressed(BlockDriverState *bs, uint64_t offset,
 958                            uint64_t bytes, QEMUIOVector *qiov)
 959 {
 960     BDRVQcowState *s = bs->opaque;
 961     QEMUIOVector hd_qiov;
 962     struct iovec iov;
 963     z_stream strm;
 964     int ret, out_len;
 965     uint8_t *buf, *out_buf;
 966     uint64_t cluster_offset;
 967
 968     buf = qemu_blockalign(bs, s->cluster_size);
 969     if (bytes != s->cluster_size) {
 970         if (bytes > s->cluster_size ||
 971             offset + bytes != bs->total_sectors << BDRV_SECTOR_BITS)
 972         {
 973             qemu_vfree(buf);
 974             return -EINVAL;
 975         }
 976         /* Zero-pad last write if image size is not cluster aligned */
 977         memset(buf + bytes, 0, s->cluster_size - bytes);
 978     }
 979     qemu_iovec_to_buf(qiov, 0, buf, qiov->size);
 980
 981     out_buf = g_malloc(s->cluster_size);
 982
 983     /* best compression, small window, no zlib header */
 984     memset(&strm, 0, sizeof(strm));
 985     ret = deflateInit2(&strm, Z_DEFAULT_COMPRESSION,
 986                        Z_DEFLATED, -12,
 987                        9, Z_DEFAULT_STRATEGY);
 988     if (ret != 0) {
 989         ret = -EINVAL;
 990         goto fail;
 991     }
 992
 993     strm.avail_in = s->cluster_size;
 994     strm.next_in = (uint8_t *)buf;
 995     strm.avail_out = s->cluster_size;
 996     strm.next_out = out_buf;
 997
 998     ret = deflate(&strm, Z_FINISH);
 999     if (ret != Z_STREAM_END && ret != Z_OK) {
1000         deflateEnd(&strm);
1001         ret = -EINVAL;
1002         goto fail;
1003     }
1004     out_len = strm.next_out - out_buf;
1005
1006     deflateEnd(&strm);
1007
1008     if (ret != Z_STREAM_END || out_len >= s->cluster_size) {
1009         /* could not compress: write normal cluster */
1010         ret = qcow_co_writev(bs, offset >> BDRV_SECTOR_BITS,
1011                              bytes >> BDRV_SECTOR_BITS, qiov);
1012         if (ret < 0) {
1013             goto fail;
1014         }
1015         goto success;
1016     }
1017     qemu_co_mutex_lock(&s->lock);
1018     ret = get_cluster_offset(bs, offset, 2, out_len, 0, 0, &cluster_offset);
1019     qemu_co_mutex_unlock(&s->lock);
1020     if (ret < 0) {
1021         goto fail;
1022     }
1023     if (cluster_offset == 0) {
1024         ret = -EIO;
1025         goto fail;
1026     }
1027     cluster_offset &= s->cluster_offset_mask;
1028
1029     iov = (struct iovec) {
1030         .iov_base   = out_buf,
1031         .iov_len    = out_len,
1032     };
1033     qemu_iovec_init_external(&hd_qiov, &iov, 1);
1034     ret = bdrv_co_pwritev(bs->file, cluster_offset, out_len, &hd_qiov, 0);
1035     if (ret < 0) {
1036         goto fail;
1037     }
1038 success:
1039     ret = 0;
1040 fail:
1041     qemu_vfree(buf);
1042     g_free(out_buf);
1043     return ret;
1044 }
1045
1046 static int qcow_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
1047 {
1048     BDRVQcowState *s = bs->opaque;
1049     bdi->cluster_size = s->cluster_size;
1050     return 0;
1051 }
1052
1053 static QemuOptsList qcow_create_opts = {
1054     .name = "qcow-create-opts",
1055     .head = QTAILQ_HEAD_INITIALIZER(qcow_create_opts.head),
1056     .desc = {
1057         {
1058             .name = BLOCK_OPT_SIZE,
1059             .type = QEMU_OPT_SIZE,
1060             .help = "Virtual disk size"
1061         },
1062         {
1063             .name = BLOCK_OPT_BACKING_FILE,
1064             .type = QEMU_OPT_STRING,
1065             .help = "File name of a base image"
1066         },
1067         {
1068             .name = BLOCK_OPT_ENCRYPT,
1069             .type = QEMU_OPT_BOOL,
1070             .help = "Encrypt the image with format 'aes'. (Deprecated "
1071                     "in favor of " BLOCK_OPT_ENCRYPT_FORMAT "=aes)",
1072         },
1073         {
1074             .name = BLOCK_OPT_ENCRYPT_FORMAT,
1075             .type = QEMU_OPT_STRING,
1076             .help = "Encrypt the image, format choices: 'aes'",
1077         },
1078         BLOCK_CRYPTO_OPT_DEF_QCOW_KEY_SECRET("encrypt."),
1079         { /* end of list */ }
1080     }
1081 };
1082
1083 static BlockDriver bdrv_qcow = {
1084     .format_name        = "qcow",
1085     .instance_size      = sizeof(BDRVQcowState),
1086     .bdrv_probe         = qcow_probe,
1087     .bdrv_open          = qcow_open,
1088     .bdrv_close         = qcow_close,
1089     .bdrv_child_perm        = bdrv_format_default_perms,
1090     .bdrv_reopen_prepare    = qcow_reopen_prepare,
1091     .bdrv_create            = qcow_create,
1092     .bdrv_has_zero_init     = bdrv_has_zero_init_1,
1093     .supports_backing       = true,
1094
1095     .bdrv_co_readv          = qcow_co_readv,
1096     .bdrv_co_writev         = qcow_co_writev,
1097     .bdrv_co_get_block_status   = qcow_co_get_block_status,
1098
1099     .bdrv_make_empty        = qcow_make_empty,
1100     .bdrv_co_pwritev_compressed = qcow_co_pwritev_compressed,
1101     .bdrv_get_info          = qcow_get_info,
1102
1103     .create_opts            = &qcow_create_opts,
1104 };
1105
1106 static void bdrv_qcow_init(void)
1107 {
1108     bdrv_register(&bdrv_qcow);
1109 }
1110
1111 block_init(bdrv_qcow_init);