qed.c 47.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
 * QEMU Enhanced Disk Format
 *
 * Copyright IBM, Corp. 2010
 *
 * Authors:
 *  Stefan Hajnoczi   <stefanha@linux.vnet.ibm.com>
 *  Anthony Liguori   <aliguori@us.ibm.com>
 *
 * This work is licensed under the terms of the GNU LGPL, version 2 or later.
 * See the COPYING.LIB file in the top-level directory.
 *
 */

P
Peter Maydell 已提交
15
#include "qemu/osdep.h"
16
#include "qapi/error.h"
17
#include "qemu/timer.h"
18
#include "qemu/bswap.h"
S
Stefan Hajnoczi 已提交
19
#include "trace.h"
20
#include "qed.h"
21
#include "qapi/qmp/qerror.h"
22
#include "sysemu/block-backend.h"
23

S
Stefan Hajnoczi 已提交
24
static const AIOCBInfo qed_aiocb_info = {
S
Stefan Hajnoczi 已提交
25 26 27
    .aiocb_size         = sizeof(QEDAIOCB),
};

28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
static int bdrv_qed_probe(const uint8_t *buf, int buf_size,
                          const char *filename)
{
    const QEDHeader *header = (const QEDHeader *)buf;

    if (buf_size < sizeof(*header)) {
        return 0;
    }
    if (le32_to_cpu(header->magic) != QED_MAGIC) {
        return 0;
    }
    return 100;
}

/**
 * Check whether an image format is raw
 *
 * @fmt:    Backing file format, may be NULL
 */
static bool qed_fmt_is_raw(const char *fmt)
{
    return fmt && strcmp(fmt, "raw") == 0;
}

static void qed_header_le_to_cpu(const QEDHeader *le, QEDHeader *cpu)
{
    cpu->magic = le32_to_cpu(le->magic);
    cpu->cluster_size = le32_to_cpu(le->cluster_size);
    cpu->table_size = le32_to_cpu(le->table_size);
    cpu->header_size = le32_to_cpu(le->header_size);
    cpu->features = le64_to_cpu(le->features);
    cpu->compat_features = le64_to_cpu(le->compat_features);
    cpu->autoclear_features = le64_to_cpu(le->autoclear_features);
    cpu->l1_table_offset = le64_to_cpu(le->l1_table_offset);
    cpu->image_size = le64_to_cpu(le->image_size);
    cpu->backing_filename_offset = le32_to_cpu(le->backing_filename_offset);
    cpu->backing_filename_size = le32_to_cpu(le->backing_filename_size);
}

static void qed_header_cpu_to_le(const QEDHeader *cpu, QEDHeader *le)
{
    le->magic = cpu_to_le32(cpu->magic);
    le->cluster_size = cpu_to_le32(cpu->cluster_size);
    le->table_size = cpu_to_le32(cpu->table_size);
    le->header_size = cpu_to_le32(cpu->header_size);
    le->features = cpu_to_le64(cpu->features);
    le->compat_features = cpu_to_le64(cpu->compat_features);
    le->autoclear_features = cpu_to_le64(cpu->autoclear_features);
    le->l1_table_offset = cpu_to_le64(cpu->l1_table_offset);
    le->image_size = cpu_to_le64(cpu->image_size);
    le->backing_filename_offset = cpu_to_le32(cpu->backing_filename_offset);
    le->backing_filename_size = cpu_to_le32(cpu->backing_filename_size);
}

82
int qed_write_header_sync(BDRVQEDState *s)
83 84 85 86 87
{
    QEDHeader le;
    int ret;

    qed_header_cpu_to_le(&s->header, &le);
88
    ret = bdrv_pwrite(s->bs->file, 0, &le, sizeof(le));
89 90 91 92 93 94
    if (ret != sizeof(le)) {
        return ret;
    }
    return 0;
}

S
Stefan Hajnoczi 已提交
95 96 97 98 99 100
/**
 * Update header in-place (does not rewrite backing filename or other strings)
 *
 * This function only updates known header fields in-place and does not affect
 * extra data after the QED header.
 */
101
static int qed_write_header(BDRVQEDState *s)
S
Stefan Hajnoczi 已提交
102 103 104 105 106 107 108
{
    /* We must write full sectors for O_DIRECT but cannot necessarily generate
     * the data following the header if an unrecognized compat feature is
     * active.  Therefore, first read the sectors containing the header, update
     * them, and write back.
     */

L
Laurent Vivier 已提交
109
    int nsectors = DIV_ROUND_UP(sizeof(QEDHeader), BDRV_SECTOR_SIZE);
S
Stefan Hajnoczi 已提交
110
    size_t len = nsectors * BDRV_SECTOR_SIZE;
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
    uint8_t *buf;
    struct iovec iov;
    QEMUIOVector qiov;
    int ret;

    buf = qemu_blockalign(s->bs, len);
    iov = (struct iovec) {
        .iov_base = buf,
        .iov_len = len,
    };
    qemu_iovec_init_external(&qiov, &iov, 1);

    ret = bdrv_preadv(s->bs->file, 0, &qiov);
    if (ret < 0) {
        goto out;
    }

    /* Update header */
    qed_header_cpu_to_le(&s->header, (QEDHeader *) buf);

    ret = bdrv_pwritev(s->bs->file, 0, &qiov);
    if (ret < 0) {
        goto out;
    }

    ret = 0;
out:
    qemu_vfree(buf);
139
    return ret;
S
Stefan Hajnoczi 已提交
140 141
}

142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
static uint64_t qed_max_image_size(uint32_t cluster_size, uint32_t table_size)
{
    uint64_t table_entries;
    uint64_t l2_size;

    table_entries = (table_size * cluster_size) / sizeof(uint64_t);
    l2_size = table_entries * cluster_size;

    return l2_size * table_entries;
}

static bool qed_is_cluster_size_valid(uint32_t cluster_size)
{
    if (cluster_size < QED_MIN_CLUSTER_SIZE ||
        cluster_size > QED_MAX_CLUSTER_SIZE) {
        return false;
    }
    if (cluster_size & (cluster_size - 1)) {
        return false; /* not power of 2 */
    }
    return true;
}

static bool qed_is_table_size_valid(uint32_t table_size)
{
    if (table_size < QED_MIN_TABLE_SIZE ||
        table_size > QED_MAX_TABLE_SIZE) {
        return false;
    }
    if (table_size & (table_size - 1)) {
        return false; /* not power of 2 */
    }
    return true;
}

static bool qed_is_image_size_valid(uint64_t image_size, uint32_t cluster_size,
                                    uint32_t table_size)
{
    if (image_size % BDRV_SECTOR_SIZE != 0) {
        return false; /* not multiple of sector size */
    }
    if (image_size > qed_max_image_size(cluster_size, table_size)) {
        return false; /* image is too large */
    }
    return true;
}

/**
 * Read a string of known length from the image file
 *
 * @file:       Image file
 * @offset:     File offset to start of string, in bytes
 * @n:          String length in bytes
 * @buf:        Destination buffer
 * @buflen:     Destination buffer length in bytes
 * @ret:        0 on success, -errno on failure
 *
 * The string is NUL-terminated.
 */
201
static int qed_read_string(BdrvChild *file, uint64_t offset, size_t n,
202 203 204 205 206 207 208 209 210 211 212 213 214 215
                           char *buf, size_t buflen)
{
    int ret;
    if (n >= buflen) {
        return -EINVAL;
    }
    ret = bdrv_pread(file, offset, buf, n);
    if (ret < 0) {
        return ret;
    }
    buf[n] = '\0';
    return 0;
}

S
Stefan Hajnoczi 已提交
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
/**
 * Allocate new clusters
 *
 * @s:          QED state
 * @n:          Number of contiguous clusters to allocate
 * @ret:        Offset of first allocated cluster
 *
 * This function only produces the offset where the new clusters should be
 * written.  It updates BDRVQEDState but does not make any changes to the image
 * file.
 */
static uint64_t qed_alloc_clusters(BDRVQEDState *s, unsigned int n)
{
    uint64_t offset = s->file_size;
    s->file_size += n * s->header.cluster_size;
    return offset;
}

234 235 236 237 238 239 240
QEDTable *qed_alloc_table(BDRVQEDState *s)
{
    /* Honor O_DIRECT memory alignment requirements */
    return qemu_blockalign(s->bs,
                           s->header.cluster_size * s->header.table_size);
}

S
Stefan Hajnoczi 已提交
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
/**
 * Allocate a new zeroed L2 table
 */
static CachedL2Table *qed_new_l2_table(BDRVQEDState *s)
{
    CachedL2Table *l2_table = qed_alloc_l2_cache_entry(&s->l2_cache);

    l2_table->table = qed_alloc_table(s);
    l2_table->offset = qed_alloc_clusters(s, s->header.table_size);

    memset(l2_table->table->offsets, 0,
           s->header.cluster_size * s->header.table_size);
    return l2_table;
}

256 257 258 259 260 261 262
static void qed_aio_next_io(QEDAIOCB *acb, int ret);

static void qed_aio_start_io(QEDAIOCB *acb)
{
    qed_aio_next_io(acb, 0);
}

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
static void qed_plug_allocating_write_reqs(BDRVQEDState *s)
{
    assert(!s->allocating_write_reqs_plugged);

    s->allocating_write_reqs_plugged = true;
}

static void qed_unplug_allocating_write_reqs(BDRVQEDState *s)
{
    QEDAIOCB *acb;

    assert(s->allocating_write_reqs_plugged);

    s->allocating_write_reqs_plugged = false;

    acb = QSIMPLEQ_FIRST(&s->allocating_write_reqs);
    if (acb) {
280
        qed_aio_start_io(acb);
281 282 283 284 285 286 287 288 289 290 291 292 293
    }
}

static void qed_clear_need_check(void *opaque, int ret)
{
    BDRVQEDState *s = opaque;

    if (ret) {
        qed_unplug_allocating_write_reqs(s);
        return;
    }

    s->header.features &= ~QED_F_NEED_CHECK;
294 295 296 297 298 299 300
    ret = qed_write_header(s);
    (void) ret;

    qed_unplug_allocating_write_reqs(s);

    ret = bdrv_flush(s->bs);
    (void) ret;
301 302 303 304 305 306 307 308 309 310 311
}

static void qed_need_check_timer_cb(void *opaque)
{
    BDRVQEDState *s = opaque;

    /* The timer should only fire when allocating writes have drained */
    assert(!QSIMPLEQ_FIRST(&s->allocating_write_reqs));

    trace_qed_need_check_timer_cb(s);

312
    qed_acquire(s);
313 314 315
    qed_plug_allocating_write_reqs(s);

    /* Ensure writes are on disk before clearing flag */
F
Fam Zheng 已提交
316
    bdrv_aio_flush(s->bs->file->bs, qed_clear_need_check, s);
317 318 319 320 321 322 323 324 325 326 327
    qed_release(s);
}

void qed_acquire(BDRVQEDState *s)
{
    aio_context_acquire(bdrv_get_aio_context(s->bs));
}

void qed_release(BDRVQEDState *s)
{
    aio_context_release(bdrv_get_aio_context(s->bs));
328 329 330 331 332 333
}

static void qed_start_need_check_timer(BDRVQEDState *s)
{
    trace_qed_start_need_check_timer(s);

334
    /* Use QEMU_CLOCK_VIRTUAL so we don't alter the image file while suspended for
335 336
     * migration.
     */
337
    timer_mod(s->need_check_timer, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) +
338
                   NANOSECONDS_PER_SECOND * QED_NEED_CHECK_TIMEOUT);
339 340 341 342 343 344
}

/* It's okay to call this multiple times or when no timer is started */
static void qed_cancel_need_check_timer(BDRVQEDState *s)
{
    trace_qed_cancel_need_check_timer(s);
345
    timer_del(s->need_check_timer);
346 347
}

348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
static void bdrv_qed_detach_aio_context(BlockDriverState *bs)
{
    BDRVQEDState *s = bs->opaque;

    qed_cancel_need_check_timer(s);
    timer_free(s->need_check_timer);
}

static void bdrv_qed_attach_aio_context(BlockDriverState *bs,
                                        AioContext *new_context)
{
    BDRVQEDState *s = bs->opaque;

    s->need_check_timer = aio_timer_new(new_context,
                                        QEMU_CLOCK_VIRTUAL, SCALE_NS,
                                        qed_need_check_timer_cb, s);
    if (s->header.features & QED_F_NEED_CHECK) {
        qed_start_need_check_timer(s);
    }
}

F
Fam Zheng 已提交
369 370 371 372 373 374 375 376 377 378 379 380 381
static void bdrv_qed_drain(BlockDriverState *bs)
{
    BDRVQEDState *s = bs->opaque;

    /* Fire the timer immediately in order to start doing I/O as soon as the
     * header is flushed.
     */
    if (s->need_check_timer && timer_pending(s->need_check_timer)) {
        qed_cancel_need_check_timer(s);
        qed_need_check_timer_cb(s);
    }
}

382 383
static int bdrv_qed_do_open(BlockDriverState *bs, QDict *options, int flags,
                            Error **errp)
384 385 386 387 388 389 390
{
    BDRVQEDState *s = bs->opaque;
    QEDHeader le_header;
    int64_t file_size;
    int ret;

    s->bs = bs;
S
Stefan Hajnoczi 已提交
391
    QSIMPLEQ_INIT(&s->allocating_write_reqs);
392

393
    ret = bdrv_pread(bs->file, 0, &le_header, sizeof(le_header));
394 395 396 397 398 399
    if (ret < 0) {
        return ret;
    }
    qed_header_le_to_cpu(&le_header, &s->header);

    if (s->header.magic != QED_MAGIC) {
P
Paolo Bonzini 已提交
400 401
        error_setg(errp, "Image not in QED format");
        return -EINVAL;
402 403
    }
    if (s->header.features & ~QED_FEATURE_MASK) {
404
        /* image uses unsupported feature bits */
405 406
        error_setg(errp, "Unsupported QED features: %" PRIx64,
                   s->header.features & ~QED_FEATURE_MASK);
407
        return -ENOTSUP;
408 409 410 411 412 413
    }
    if (!qed_is_cluster_size_valid(s->header.cluster_size)) {
        return -EINVAL;
    }

    /* Round down file size to the last cluster */
K
Kevin Wolf 已提交
414
    file_size = bdrv_getlength(bs->file->bs);
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
    if (file_size < 0) {
        return file_size;
    }
    s->file_size = qed_start_of_cluster(s, file_size);

    if (!qed_is_table_size_valid(s->header.table_size)) {
        return -EINVAL;
    }
    if (!qed_is_image_size_valid(s->header.image_size,
                                 s->header.cluster_size,
                                 s->header.table_size)) {
        return -EINVAL;
    }
    if (!qed_check_table_offset(s, s->header.l1_table_offset)) {
        return -EINVAL;
    }

    s->table_nelems = (s->header.cluster_size * s->header.table_size) /
                      sizeof(uint64_t);
434
    s->l2_shift = ctz32(s->header.cluster_size);
435
    s->l2_mask = s->table_nelems - 1;
436
    s->l1_shift = s->l2_shift + ctz32(s->table_nelems);
437

438 439 440 441 442
    /* Header size calculation must not overflow uint32_t */
    if (s->header.header_size > UINT32_MAX / s->header.cluster_size) {
        return -EINVAL;
    }

443 444 445 446 447 448 449
    if ((s->header.features & QED_F_BACKING_FILE)) {
        if ((uint64_t)s->header.backing_filename_offset +
            s->header.backing_filename_size >
            s->header.cluster_size * s->header.header_size) {
            return -EINVAL;
        }

450
        ret = qed_read_string(bs->file, s->header.backing_filename_offset,
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
                              s->header.backing_filename_size, bs->backing_file,
                              sizeof(bs->backing_file));
        if (ret < 0) {
            return ret;
        }

        if (s->header.features & QED_F_BACKING_FORMAT_NO_PROBE) {
            pstrcpy(bs->backing_format, sizeof(bs->backing_format), "raw");
        }
    }

    /* Reset unknown autoclear feature bits.  This is a backwards
     * compatibility mechanism that allows images to be opened by older
     * programs, which "knock out" unknown feature bits.  When an image is
     * opened by a newer program again it can detect that the autoclear
     * feature is no longer valid.
     */
    if ((s->header.autoclear_features & ~QED_AUTOCLEAR_FEATURE_MASK) != 0 &&
469
        !bdrv_is_read_only(bs->file->bs) && !(flags & BDRV_O_INACTIVE)) {
470 471 472 473 474 475 476 477
        s->header.autoclear_features &= QED_AUTOCLEAR_FEATURE_MASK;

        ret = qed_write_header_sync(s);
        if (ret) {
            return ret;
        }

        /* From here on only known autoclear feature bits are valid */
K
Kevin Wolf 已提交
478
        bdrv_flush(bs->file->bs);
479 480
    }

481 482 483 484
    s->l1_table = qed_alloc_table(s);
    qed_init_l2_cache(&s->l2_cache);

    ret = qed_read_l1_table_sync(s);
S
Stefan Hajnoczi 已提交
485 486 487 488 489
    if (ret) {
        goto out;
    }

    /* If image was not closed cleanly, check consistency */
490
    if (!(flags & BDRV_O_CHECK) && (s->header.features & QED_F_NEED_CHECK)) {
S
Stefan Hajnoczi 已提交
491 492 493 494 495
        /* Read-only images cannot be fixed.  There is no risk of corruption
         * since write operations are not possible.  Therefore, allow
         * potentially inconsistent images to be opened read-only.  This can
         * aid data recovery from an otherwise inconsistent image.
         */
K
Kevin Wolf 已提交
496
        if (!bdrv_is_read_only(bs->file->bs) &&
497
            !(flags & BDRV_O_INACTIVE)) {
S
Stefan Hajnoczi 已提交
498 499 500
            BdrvCheckResult result = {0};

            ret = qed_check(s, &result, true);
501 502 503
            if (ret) {
                goto out;
            }
S
Stefan Hajnoczi 已提交
504 505 506
        }
    }

507
    bdrv_qed_attach_aio_context(bs, bdrv_get_aio_context(bs));
508

S
Stefan Hajnoczi 已提交
509
out:
510 511 512 513
    if (ret) {
        qed_free_l2_cache(&s->l2_cache);
        qemu_vfree(s->l1_table);
    }
514 515 516
    return ret;
}

517 518 519 520 521 522 523 524 525 526 527 528
static int bdrv_qed_open(BlockDriverState *bs, QDict *options, int flags,
                         Error **errp)
{
    bs->file = bdrv_open_child(NULL, options, "file", bs, &child_file,
                               false, errp);
    if (!bs->file) {
        return -EINVAL;
    }

    return bdrv_qed_do_open(bs, options, flags, errp);
}

529
static void bdrv_qed_refresh_limits(BlockDriverState *bs, Error **errp)
530 531 532
{
    BDRVQEDState *s = bs->opaque;

533
    bs->bl.pwrite_zeroes_alignment = s->header.cluster_size;
534 535
}

J
Jeff Cody 已提交
536 537 538 539 540 541 542 543
/* We have nothing to do for QED reopen, stubs just return
 * success */
static int bdrv_qed_reopen_prepare(BDRVReopenState *state,
                                   BlockReopenQueue *queue, Error **errp)
{
    return 0;
}

544 545
static void bdrv_qed_close(BlockDriverState *bs)
{
546 547
    BDRVQEDState *s = bs->opaque;

548
    bdrv_qed_detach_aio_context(bs);
549

S
Stefan Hajnoczi 已提交
550
    /* Ensure writes reach stable storage */
K
Kevin Wolf 已提交
551
    bdrv_flush(bs->file->bs);
S
Stefan Hajnoczi 已提交
552 553 554 555 556 557 558

    /* Clean shutdown, no check required on next open */
    if (s->header.features & QED_F_NEED_CHECK) {
        s->header.features &= ~QED_F_NEED_CHECK;
        qed_write_header_sync(s);
    }

559 560
    qed_free_l2_cache(&s->l2_cache);
    qemu_vfree(s->l1_table);
561 562 563 564
}

static int qed_create(const char *filename, uint32_t cluster_size,
                      uint64_t image_size, uint32_t table_size,
P
Paolo Bonzini 已提交
565
                      const char *backing_file, const char *backing_fmt,
566
                      QemuOpts *opts, Error **errp)
567 568 569 570 571 572 573 574 575 576 577 578 579 580
{
    QEDHeader header = {
        .magic = QED_MAGIC,
        .cluster_size = cluster_size,
        .table_size = table_size,
        .header_size = 1,
        .features = 0,
        .compat_features = 0,
        .l1_table_offset = cluster_size,
        .image_size = image_size,
    };
    QEDHeader le_header;
    uint8_t *l1_table = NULL;
    size_t l1_size = header.cluster_size * header.table_size;
581
    Error *local_err = NULL;
582
    int ret = 0;
583
    BlockBackend *blk;
584

585
    ret = bdrv_create_file(filename, opts, &local_err);
586
    if (ret < 0) {
P
Paolo Bonzini 已提交
587
        error_propagate(errp, local_err);
588 589 590
        return ret;
    }

591
    blk = blk_new_open(filename, NULL, NULL,
592 593
                       BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL,
                       &local_err);
594
    if (blk == NULL) {
P
Paolo Bonzini 已提交
595
        error_propagate(errp, local_err);
596
        return -EIO;
597 598
    }

599 600
    blk_set_allow_write_beyond_eof(blk, true);

601
    /* File must start empty and grow, check truncate is supported */
602
    ret = blk_truncate(blk, 0, errp);
603 604 605 606
    if (ret < 0) {
        goto out;
    }

607 608 609 610 611 612 613 614 615 616 617
    if (backing_file) {
        header.features |= QED_F_BACKING_FILE;
        header.backing_filename_offset = sizeof(le_header);
        header.backing_filename_size = strlen(backing_file);

        if (qed_fmt_is_raw(backing_fmt)) {
            header.features |= QED_F_BACKING_FORMAT_NO_PROBE;
        }
    }

    qed_header_cpu_to_le(&header, &le_header);
618
    ret = blk_pwrite(blk, 0, &le_header, sizeof(le_header), 0);
619 620 621
    if (ret < 0) {
        goto out;
    }
622
    ret = blk_pwrite(blk, sizeof(le_header), backing_file,
623
                     header.backing_filename_size, 0);
624 625 626 627
    if (ret < 0) {
        goto out;
    }

628
    l1_table = g_malloc0(l1_size);
629
    ret = blk_pwrite(blk, header.l1_table_offset, l1_table, l1_size, 0);
630 631 632 633 634 635
    if (ret < 0) {
        goto out;
    }

    ret = 0; /* success */
out:
636
    g_free(l1_table);
637
    blk_unref(blk);
638 639 640
    return ret;
}

641
static int bdrv_qed_create(const char *filename, QemuOpts *opts, Error **errp)
642 643 644 645
{
    uint64_t image_size = 0;
    uint32_t cluster_size = QED_DEFAULT_CLUSTER_SIZE;
    uint32_t table_size = QED_DEFAULT_TABLE_SIZE;
646 647 648 649
    char *backing_file = NULL;
    char *backing_fmt = NULL;
    int ret;

650 651
    image_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
                          BDRV_SECTOR_SIZE);
652 653 654 655 656 657 658
    backing_file = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FILE);
    backing_fmt = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FMT);
    cluster_size = qemu_opt_get_size_del(opts,
                                         BLOCK_OPT_CLUSTER_SIZE,
                                         QED_DEFAULT_CLUSTER_SIZE);
    table_size = qemu_opt_get_size_del(opts, BLOCK_OPT_TABLE_SIZE,
                                       QED_DEFAULT_TABLE_SIZE);
659 660

    if (!qed_is_cluster_size_valid(cluster_size)) {
661 662 663
        error_setg(errp, "QED cluster size must be within range [%u, %u] "
                         "and power of 2",
                   QED_MIN_CLUSTER_SIZE, QED_MAX_CLUSTER_SIZE);
664 665
        ret = -EINVAL;
        goto finish;
666 667
    }
    if (!qed_is_table_size_valid(table_size)) {
668 669 670
        error_setg(errp, "QED table size must be within range [%u, %u] "
                         "and power of 2",
                   QED_MIN_TABLE_SIZE, QED_MAX_TABLE_SIZE);
671 672
        ret = -EINVAL;
        goto finish;
673 674
    }
    if (!qed_is_image_size_valid(image_size, cluster_size, table_size)) {
675 676 677
        error_setg(errp, "QED image size must be a non-zero multiple of "
                         "cluster size and less than %" PRIu64 " bytes",
                   qed_max_image_size(cluster_size, table_size));
678 679
        ret = -EINVAL;
        goto finish;
680 681
    }

682
    ret = qed_create(filename, cluster_size, image_size, table_size,
683
                     backing_file, backing_fmt, opts, errp);
684 685 686 687 688

finish:
    g_free(backing_file);
    g_free(backing_fmt);
    return ret;
689 690
}

691
typedef struct {
692
    BlockDriverState *bs;
693
    Coroutine *co;
694 695
    uint64_t pos;
    int64_t status;
696
    int *pnum;
697
    BlockDriverState **file;
698 699 700 701 702
} QEDIsAllocatedCB;

static void qed_is_allocated_cb(void *opaque, int ret, uint64_t offset, size_t len)
{
    QEDIsAllocatedCB *cb = opaque;
703
    BDRVQEDState *s = cb->bs->opaque;
704
    *cb->pnum = len / BDRV_SECTOR_SIZE;
705 706 707 708
    switch (ret) {
    case QED_CLUSTER_FOUND:
        offset |= qed_offset_into_cluster(s, cb->pos);
        cb->status = BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID | offset;
709
        *cb->file = cb->bs->file->bs;
710 711 712 713 714 715 716 717 718 719 720 721 722 723
        break;
    case QED_CLUSTER_ZERO:
        cb->status = BDRV_BLOCK_ZERO;
        break;
    case QED_CLUSTER_L2:
    case QED_CLUSTER_L1:
        cb->status = 0;
        break;
    default:
        assert(ret < 0);
        cb->status = ret;
        break;
    }

724
    if (cb->co) {
725
        aio_co_wake(cb->co);
726
    }
727 728
}

729
static int64_t coroutine_fn bdrv_qed_co_get_block_status(BlockDriverState *bs,
730
                                                 int64_t sector_num,
731 732
                                                 int nb_sectors, int *pnum,
                                                 BlockDriverState **file)
733
{
734 735 736
    BDRVQEDState *s = bs->opaque;
    size_t len = (size_t)nb_sectors * BDRV_SECTOR_SIZE;
    QEDIsAllocatedCB cb = {
737 738 739
        .bs = bs,
        .pos = (uint64_t)sector_num * BDRV_SECTOR_SIZE,
        .status = BDRV_BLOCK_OFFSET_MASK,
740
        .pnum = pnum,
741
        .file = file,
742 743
    };
    QEDRequest request = { .l2_table = NULL };
744 745
    uint64_t offset;
    int ret;
746

747 748
    ret = qed_find_cluster(s, &request, cb.pos, &len, &offset);
    qed_is_allocated_cb(&cb, ret, offset, len);
749

750 751
    /* The callback was invoked immediately */
    assert(cb.status != BDRV_BLOCK_OFFSET_MASK);
752 753 754

    qed_unref_l2_cache_entry(request.l2_table);

755
    return cb.status;
756 757
}

S
Stefan Hajnoczi 已提交
758 759 760 761 762 763 764 765
static BDRVQEDState *acb_to_s(QEDAIOCB *acb)
{
    return acb->common.bs->opaque;
}

/**
 * Read from the backing file or zero-fill if no backing file
 *
766 767 768 769 770 771
 * @s:              QED state
 * @pos:            Byte position in device
 * @qiov:           Destination I/O vector
 * @backing_qiov:   Possibly shortened copy of qiov, to be allocated here
 * @cb:             Completion function
 * @opaque:         User data for completion function
S
Stefan Hajnoczi 已提交
772 773 774 775
 *
 * This function reads qiov->size bytes starting at pos from the backing file.
 * If there is no backing file then zeroes are read.
 */
776 777 778
static int qed_read_backing_file(BDRVQEDState *s, uint64_t pos,
                                 QEMUIOVector *qiov,
                                 QEMUIOVector **backing_qiov)
S
Stefan Hajnoczi 已提交
779 780 781
{
    uint64_t backing_length = 0;
    size_t size;
782
    int ret;
S
Stefan Hajnoczi 已提交
783 784 785 786

    /* If there is a backing file, get its length.  Treat the absence of a
     * backing file like a zero length backing file.
     */
787 788
    if (s->bs->backing) {
        int64_t l = bdrv_getlength(s->bs->backing->bs);
S
Stefan Hajnoczi 已提交
789
        if (l < 0) {
790
            return l;
S
Stefan Hajnoczi 已提交
791 792 793 794 795 796 797
        }
        backing_length = l;
    }

    /* Zero all sectors if reading beyond the end of the backing file */
    if (pos >= backing_length ||
        pos + qiov->size > backing_length) {
798
        qemu_iovec_memset(qiov, 0, 0, qiov->size);
S
Stefan Hajnoczi 已提交
799 800 801 802
    }

    /* Complete now if there are no backing file sectors to read */
    if (pos >= backing_length) {
803
        return 0;
S
Stefan Hajnoczi 已提交
804 805 806 807 808
    }

    /* If the read straddles the end of the backing file, shorten it */
    size = MIN((uint64_t)backing_length - pos, qiov->size);

809 810 811 812 813
    assert(*backing_qiov == NULL);
    *backing_qiov = g_new(QEMUIOVector, 1);
    qemu_iovec_init(*backing_qiov, qiov->niov);
    qemu_iovec_concat(*backing_qiov, qiov, 0, size);

P
Paolo Bonzini 已提交
814
    BLKDBG_EVENT(s->bs->file, BLKDBG_READ_BACKING_AIO);
815 816 817 818 819
    ret = bdrv_preadv(s->bs->backing, pos, *backing_qiov);
    if (ret < 0) {
        return ret;
    }
    return 0;
S
Stefan Hajnoczi 已提交
820 821 822 823 824 825 826 827 828 829
}

/**
 * Copy data from backing file into the image
 *
 * @s:          QED state
 * @pos:        Byte position in device
 * @len:        Number of bytes
 * @offset:     Byte offset in image file
 */
830 831
static int qed_copy_from_backing_file(BDRVQEDState *s, uint64_t pos,
                                      uint64_t len, uint64_t offset)
S
Stefan Hajnoczi 已提交
832
{
833 834 835
    QEMUIOVector qiov;
    QEMUIOVector *backing_qiov = NULL;
    struct iovec iov;
836
    int ret;
S
Stefan Hajnoczi 已提交
837 838 839

    /* Skip copy entirely if there is no work to do */
    if (len == 0) {
840
        return 0;
S
Stefan Hajnoczi 已提交
841 842
    }

843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
    iov = (struct iovec) {
        .iov_base = qemu_blockalign(s->bs, len),
        .iov_len = len,
    };
    qemu_iovec_init_external(&qiov, &iov, 1);

    ret = qed_read_backing_file(s, pos, &qiov, &backing_qiov);

    if (backing_qiov) {
        qemu_iovec_destroy(backing_qiov);
        g_free(backing_qiov);
        backing_qiov = NULL;
    }

    if (ret) {
        goto out;
    }
S
Stefan Hajnoczi 已提交
860

861 862 863 864 865 866 867 868
    BLKDBG_EVENT(s->bs->file, BLKDBG_COW_WRITE);
    ret = bdrv_pwritev(s->bs->file, offset, &qiov);
    if (ret < 0) {
        goto out;
    }
    ret = 0;
out:
    qemu_vfree(iov.iov_base);
869
    return ret;
S
Stefan Hajnoczi 已提交
870 871 872 873 874 875 876 877 878
}

/**
 * Link one or more contiguous clusters into a table
 *
 * @s:              QED state
 * @table:          L2 table
 * @index:          First cluster index
 * @n:              Number of contiguous clusters
879 880 881 882
 * @cluster:        First cluster offset
 *
 * The cluster offset may be an allocated byte offset in the image file, the
 * zero cluster marker, or the unallocated cluster marker.
S
Stefan Hajnoczi 已提交
883 884 885 886 887 888 889
 */
static void qed_update_l2_table(BDRVQEDState *s, QEDTable *table, int index,
                                unsigned int n, uint64_t cluster)
{
    int i;
    for (i = index; i < index + n; i++) {
        table->offsets[i] = cluster;
890 891 892 893
        if (!qed_offset_is_unalloc_cluster(cluster) &&
            !qed_offset_is_zero_cluster(cluster)) {
            cluster += s->header.cluster_size;
        }
S
Stefan Hajnoczi 已提交
894 895 896 897 898 899
    }
}

static void qed_aio_complete_bh(void *opaque)
{
    QEDAIOCB *acb = opaque;
900
    BDRVQEDState *s = acb_to_s(acb);
901
    BlockCompletionFunc *cb = acb->common.cb;
S
Stefan Hajnoczi 已提交
902 903 904
    void *user_opaque = acb->common.opaque;
    int ret = acb->bh_ret;

905
    qemu_aio_unref(acb);
S
Stefan Hajnoczi 已提交
906 907

    /* Invoke callback */
908
    qed_acquire(s);
S
Stefan Hajnoczi 已提交
909
    cb(user_opaque, ret);
910
    qed_release(s);
S
Stefan Hajnoczi 已提交
911 912
}

913 914 915 916 917
static void qed_resume_alloc_bh(void *opaque)
{
    qed_aio_start_io(opaque);
}

S
Stefan Hajnoczi 已提交
918 919 920 921 922 923 924 925 926 927
static void qed_aio_complete(QEDAIOCB *acb, int ret)
{
    BDRVQEDState *s = acb_to_s(acb);

    trace_qed_aio_complete(s, acb, ret);

    /* Free resources */
    qemu_iovec_destroy(&acb->cur_qiov);
    qed_unref_l2_cache_entry(acb->request.l2_table);

928 929 930 931 932 933
    /* Free the buffer we may have allocated for zero writes */
    if (acb->flags & QED_AIOCB_ZERO) {
        qemu_vfree(acb->qiov->iov[0].iov_base);
        acb->qiov->iov[0].iov_base = NULL;
    }

S
Stefan Hajnoczi 已提交
934 935
    /* Arrange for a bh to invoke the completion function */
    acb->bh_ret = ret;
P
Paolo Bonzini 已提交
936 937
    aio_bh_schedule_oneshot(bdrv_get_aio_context(acb->common.bs),
                            qed_aio_complete_bh, acb);
S
Stefan Hajnoczi 已提交
938 939 940 941 942 943 944 945

    /* Start next allocating write request waiting behind this one.  Note that
     * requests enqueue themselves when they first hit an unallocated cluster
     * but they wait until the entire request is finished before waking up the
     * next request in the queue.  This ensures that we don't cycle through
     * requests multiple times but rather finish one at a time completely.
     */
    if (acb == QSIMPLEQ_FIRST(&s->allocating_write_reqs)) {
946
        QEDAIOCB *next_acb;
S
Stefan Hajnoczi 已提交
947
        QSIMPLEQ_REMOVE_HEAD(&s->allocating_write_reqs, next);
948 949 950 951
        next_acb = QSIMPLEQ_FIRST(&s->allocating_write_reqs);
        if (next_acb) {
            aio_bh_schedule_oneshot(bdrv_get_aio_context(acb->common.bs),
                                    qed_resume_alloc_bh, next_acb);
952 953
        } else if (s->header.features & QED_F_NEED_CHECK) {
            qed_start_need_check_timer(s);
S
Stefan Hajnoczi 已提交
954 955 956 957 958
        }
    }
}

/**
K
Kevin Wolf 已提交
959
 * Update L1 table with new L2 table offset and write it out
S
Stefan Hajnoczi 已提交
960
 */
961
static int qed_aio_write_l1_update(QEDAIOCB *acb)
S
Stefan Hajnoczi 已提交
962 963 964
{
    BDRVQEDState *s = acb_to_s(acb);
    CachedL2Table *l2_table = acb->request.l2_table;
965
    uint64_t l2_offset = l2_table->offset;
966
    int index, ret;
S
Stefan Hajnoczi 已提交
967

K
Kevin Wolf 已提交
968 969 970 971 972 973
    index = qed_l1_index(s, acb->cur_pos);
    s->l1_table->offsets[index] = l2_table->offset;

    ret = qed_write_l1_table(s, index, 1);

    /* Commit the current L2 table to the cache */
S
Stefan Hajnoczi 已提交
974 975 976 977 978
    qed_commit_l2_cache_entry(&s->l2_cache, l2_table);

    /* This is guaranteed to succeed because we just committed the entry to the
     * cache.
     */
979
    acb->request.l2_table = qed_find_l2_cache_entry(&s->l2_cache, l2_offset);
S
Stefan Hajnoczi 已提交
980 981
    assert(acb->request.l2_table != NULL);

982
    return ret;
S
Stefan Hajnoczi 已提交
983 984 985 986 987 988
}


/**
 * Update L2 table with new cluster offsets and write them out
 */
989
static int qed_aio_write_l2_update(QEDAIOCB *acb, uint64_t offset)
S
Stefan Hajnoczi 已提交
990 991 992
{
    BDRVQEDState *s = acb_to_s(acb);
    bool need_alloc = acb->find_cluster_ret == QED_CLUSTER_L1;
993
    int index, ret;
S
Stefan Hajnoczi 已提交
994 995 996 997 998 999 1000 1001

    if (need_alloc) {
        qed_unref_l2_cache_entry(acb->request.l2_table);
        acb->request.l2_table = qed_new_l2_table(s);
    }

    index = qed_l2_index(s, acb->cur_pos);
    qed_update_l2_table(s, acb->request.l2_table->table, index, acb->cur_nclusters,
1002
                         offset);
S
Stefan Hajnoczi 已提交
1003 1004 1005

    if (need_alloc) {
        /* Write out the whole new L2 table */
1006
        ret = qed_write_l2_table(s, &acb->request, 0, s->table_nelems, true);
1007
        if (ret) {
1008
            return ret;
1009
        }
1010
        return qed_aio_write_l1_update(acb);
S
Stefan Hajnoczi 已提交
1011 1012
    } else {
        /* Write out only the updated part of the L2 table */
1013 1014
        ret = qed_write_l2_table(s, &acb->request, index, acb->cur_nclusters,
                                 false);
1015 1016 1017
        if (ret) {
            return ret;
        }
S
Stefan Hajnoczi 已提交
1018
    }
1019
    return 0;
S
Stefan Hajnoczi 已提交
1020 1021 1022 1023 1024
}

/**
 * Write data to the image file
 */
1025
static int qed_aio_write_main(QEDAIOCB *acb)
S
Stefan Hajnoczi 已提交
1026 1027 1028 1029
{
    BDRVQEDState *s = acb_to_s(acb);
    uint64_t offset = acb->cur_cluster +
                      qed_offset_into_cluster(s, acb->cur_pos);
1030
    int ret;
S
Stefan Hajnoczi 已提交
1031

1032
    trace_qed_aio_write_main(s, acb, 0, offset, acb->cur_qiov.size);
S
Stefan Hajnoczi 已提交
1033

1034 1035
    BLKDBG_EVENT(s->bs->file, BLKDBG_WRITE_AIO);
    ret = bdrv_pwritev(s->bs->file, offset, &acb->cur_qiov);
1036 1037
    if (ret < 0) {
        return ret;
1038 1039
    }

1040
    if (acb->find_cluster_ret != QED_CLUSTER_FOUND) {
1041
        if (s->bs->backing) {
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
            /*
             * Flush new data clusters before updating the L2 table
             *
             * This flush is necessary when a backing file is in use.  A crash
             * during an allocating write could result in empty clusters in the
             * image.  If the write only touched a subregion of the cluster,
             * then backing image sectors have been lost in the untouched
             * region.  The solution is to flush after writing a new data
             * cluster and before updating the L2 table.
             */
            ret = bdrv_flush(s->bs->file->bs);
1053 1054 1055
            if (ret < 0) {
                return ret;
            }
1056 1057
        }
        ret = qed_aio_write_l2_update(acb, acb->cur_cluster);
1058 1059
        if (ret < 0) {
            return ret;
1060
        }
S
Stefan Hajnoczi 已提交
1061
    }
1062
    return 0;
S
Stefan Hajnoczi 已提交
1063 1064 1065
}

/**
1066
 * Populate untouched regions of new data cluster
S
Stefan Hajnoczi 已提交
1067
 */
1068
static int qed_aio_write_cow(QEDAIOCB *acb)
S
Stefan Hajnoczi 已提交
1069 1070
{
    BDRVQEDState *s = acb_to_s(acb);
1071
    uint64_t start, len, offset;
1072
    int ret;
S
Stefan Hajnoczi 已提交
1073

1074 1075 1076 1077 1078 1079
    /* Populate front untouched region of new data cluster */
    start = qed_start_of_cluster(s, acb->cur_pos);
    len = qed_offset_into_cluster(s, acb->cur_pos);

    trace_qed_aio_write_prefill(s, acb, start, len, acb->cur_cluster);
    ret = qed_copy_from_backing_file(s, start, len, acb->cur_cluster);
1080 1081
    if (ret < 0) {
        return ret;
S
Stefan Hajnoczi 已提交
1082 1083
    }

1084 1085 1086 1087 1088 1089
    /* Populate back untouched region of new data cluster */
    start = acb->cur_pos + acb->cur_qiov.size;
    len = qed_start_of_cluster(s, start + s->header.cluster_size - 1) - start;
    offset = acb->cur_cluster +
             qed_offset_into_cluster(s, acb->cur_pos) +
             acb->cur_qiov.size;
S
Stefan Hajnoczi 已提交
1090

1091 1092
    trace_qed_aio_write_postfill(s, acb, start, len, offset);
    ret = qed_copy_from_backing_file(s, start, len, offset);
1093
    if (ret < 0) {
1094
        return ret;
1095
    }
1096 1097

    return qed_aio_write_main(acb);
S
Stefan Hajnoczi 已提交
1098 1099
}

1100 1101 1102 1103 1104 1105
/**
 * Check if the QED_F_NEED_CHECK bit should be set during allocating write
 */
static bool qed_should_set_need_check(BDRVQEDState *s)
{
    /* The flush before L2 update path ensures consistency */
1106
    if (s->bs->backing) {
1107 1108 1109 1110 1111 1112
        return false;
    }

    return !(s->header.features & QED_F_NEED_CHECK);
}

S
Stefan Hajnoczi 已提交
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
/**
 * Write new data cluster
 *
 * @acb:        Write request
 * @len:        Length in bytes
 *
 * This path is taken when writing to previously unallocated clusters.
 */
static void qed_aio_write_alloc(QEDAIOCB *acb, size_t len)
{
    BDRVQEDState *s = acb_to_s(acb);
1124
    int ret;
S
Stefan Hajnoczi 已提交
1125

1126 1127 1128 1129 1130
    /* Cancel timer when the first allocating request comes in */
    if (QSIMPLEQ_EMPTY(&s->allocating_write_reqs)) {
        qed_cancel_need_check_timer(s);
    }

S
Stefan Hajnoczi 已提交
1131 1132 1133 1134
    /* Freeze this request if another allocating write is in progress */
    if (acb != QSIMPLEQ_FIRST(&s->allocating_write_reqs)) {
        QSIMPLEQ_INSERT_TAIL(&s->allocating_write_reqs, acb, next);
    }
1135 1136
    if (acb != QSIMPLEQ_FIRST(&s->allocating_write_reqs) ||
        s->allocating_write_reqs_plugged) {
S
Stefan Hajnoczi 已提交
1137 1138 1139 1140 1141
        return; /* wait for existing request to finish */
    }

    acb->cur_nclusters = qed_bytes_to_clusters(s,
            qed_offset_into_cluster(s, acb->cur_pos) + len);
1142
    qemu_iovec_concat(&acb->cur_qiov, acb->qiov, acb->qiov_offset, len);
S
Stefan Hajnoczi 已提交
1143

1144 1145 1146
    if (acb->flags & QED_AIOCB_ZERO) {
        /* Skip ahead if the clusters are already zero */
        if (acb->find_cluster_ret == QED_CLUSTER_ZERO) {
1147
            qed_aio_start_io(acb);
1148 1149 1150 1151 1152 1153
            return;
        }
    } else {
        acb->cur_cluster = qed_alloc_clusters(s, acb->cur_nclusters);
    }

1154 1155
    if (qed_should_set_need_check(s)) {
        s->header.features |= QED_F_NEED_CHECK;
1156
        ret = qed_write_header(s);
1157 1158 1159 1160 1161 1162 1163 1164
        if (ret < 0) {
            qed_aio_complete(acb, ret);
            return;
        }
    }

    if (acb->flags & QED_AIOCB_ZERO) {
        ret = qed_aio_write_l2_update(acb, 1);
1165
    } else {
1166
        ret = qed_aio_write_cow(acb);
S
Stefan Hajnoczi 已提交
1167
    }
1168 1169 1170 1171 1172
    if (ret < 0) {
        qed_aio_complete(acb, ret);
        return;
    }
    qed_aio_next_io(acb, 0);
S
Stefan Hajnoczi 已提交
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
}

/**
 * Write data cluster in place
 *
 * @acb:        Write request
 * @offset:     Cluster offset in bytes
 * @len:        Length in bytes
 *
 * This path is taken when writing to already allocated clusters.
 */
static void qed_aio_write_inplace(QEDAIOCB *acb, uint64_t offset, size_t len)
{
1186 1187
    int ret;

1188 1189 1190 1191 1192
    /* Allocate buffer for zero writes */
    if (acb->flags & QED_AIOCB_ZERO) {
        struct iovec *iov = acb->qiov->iov;

        if (!iov->iov_base) {
1193 1194 1195 1196 1197
            iov->iov_base = qemu_try_blockalign(acb->common.bs, iov->iov_len);
            if (iov->iov_base == NULL) {
                qed_aio_complete(acb, -ENOMEM);
                return;
            }
1198 1199 1200 1201
            memset(iov->iov_base, 0, iov->iov_len);
        }
    }

S
Stefan Hajnoczi 已提交
1202 1203
    /* Calculate the I/O vector */
    acb->cur_cluster = offset;
1204
    qemu_iovec_concat(&acb->cur_qiov, acb->qiov, acb->qiov_offset, len);
S
Stefan Hajnoczi 已提交
1205 1206

    /* Do the actual write */
1207 1208 1209 1210 1211 1212
    ret = qed_aio_write_main(acb);
    if (ret < 0) {
        qed_aio_complete(acb, ret);
        return;
    }
    qed_aio_next_io(acb, 0);
S
Stefan Hajnoczi 已提交
1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
}

/**
 * Write data cluster
 *
 * @opaque:     Write request
 * @ret:        QED_CLUSTER_FOUND, QED_CLUSTER_L2, QED_CLUSTER_L1,
 *              or -errno
 * @offset:     Cluster offset in bytes
 * @len:        Length in bytes
 */
static void qed_aio_write_data(void *opaque, int ret,
                               uint64_t offset, size_t len)
{
    QEDAIOCB *acb = opaque;

    trace_qed_aio_write_data(acb_to_s(acb), acb, ret, offset, len);

    acb->find_cluster_ret = ret;

    switch (ret) {
    case QED_CLUSTER_FOUND:
        qed_aio_write_inplace(acb, offset, len);
        break;

    case QED_CLUSTER_L2:
    case QED_CLUSTER_L1:
1240
    case QED_CLUSTER_ZERO:
S
Stefan Hajnoczi 已提交
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
        qed_aio_write_alloc(acb, len);
        break;

    default:
        qed_aio_complete(acb, ret);
        break;
    }
}

/**
 * Read data cluster
 *
 * @opaque:     Read request
 * @ret:        QED_CLUSTER_FOUND, QED_CLUSTER_L2, QED_CLUSTER_L1,
 *              or -errno
 * @offset:     Cluster offset in bytes
 * @len:        Length in bytes
 */
static void qed_aio_read_data(void *opaque, int ret,
                              uint64_t offset, size_t len)
{
    QEDAIOCB *acb = opaque;
    BDRVQEDState *s = acb_to_s(acb);
    BlockDriverState *bs = acb->common.bs;

    /* Adjust offset into cluster */
    offset += qed_offset_into_cluster(s, acb->cur_pos);

    trace_qed_aio_read_data(s, acb, ret, offset, len);

    if (ret < 0) {
        goto err;
    }

1275
    qemu_iovec_concat(&acb->cur_qiov, acb->qiov, acb->qiov_offset, len);
S
Stefan Hajnoczi 已提交
1276

1277 1278
    /* Handle zero cluster and backing file reads */
    if (ret == QED_CLUSTER_ZERO) {
1279
        qemu_iovec_memset(&acb->cur_qiov, 0, 0, acb->cur_qiov.size);
1280
        qed_aio_start_io(acb);
1281 1282
        return;
    } else if (ret != QED_CLUSTER_FOUND) {
1283 1284 1285
        ret = qed_read_backing_file(s, acb->cur_pos, &acb->cur_qiov,
                                    &acb->backing_qiov);
        qed_aio_next_io(acb, ret);
S
Stefan Hajnoczi 已提交
1286 1287 1288 1289
        return;
    }

    BLKDBG_EVENT(bs->file, BLKDBG_READ_AIO);
1290 1291 1292 1293 1294
    ret = bdrv_preadv(bs->file, offset, &acb->cur_qiov);
    if (ret < 0) {
        goto err;
    }
    qed_aio_next_io(acb, 0);
S
Stefan Hajnoczi 已提交
1295 1296 1297 1298 1299 1300 1301 1302 1303
    return;

err:
    qed_aio_complete(acb, ret);
}

/**
 * Begin next I/O or complete the request
 */
1304
static void qed_aio_next_io(QEDAIOCB *acb, int ret)
S
Stefan Hajnoczi 已提交
1305 1306
{
    BDRVQEDState *s = acb_to_s(acb);
1307 1308
    QEDFindClusterFunc *io_fn = (acb->flags & QED_AIOCB_WRITE) ?
                                qed_aio_write_data : qed_aio_read_data;
1309 1310
    uint64_t offset;
    size_t len;
S
Stefan Hajnoczi 已提交
1311 1312 1313

    trace_qed_aio_next_io(s, acb, ret, acb->cur_pos + acb->cur_qiov.size);

1314 1315 1316 1317 1318 1319
    if (acb->backing_qiov) {
        qemu_iovec_destroy(acb->backing_qiov);
        g_free(acb->backing_qiov);
        acb->backing_qiov = NULL;
    }

S
Stefan Hajnoczi 已提交
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
    /* Handle I/O error */
    if (ret) {
        qed_aio_complete(acb, ret);
        return;
    }

    acb->qiov_offset += acb->cur_qiov.size;
    acb->cur_pos += acb->cur_qiov.size;
    qemu_iovec_reset(&acb->cur_qiov);

    /* Complete request */
    if (acb->cur_pos >= acb->end_pos) {
        qed_aio_complete(acb, 0);
        return;
    }

    /* Find next cluster and start I/O */
1337 1338 1339
    len = acb->end_pos - acb->cur_pos;
    ret = qed_find_cluster(s, &acb->request, acb->cur_pos, &len, &offset);
    io_fn(acb, ret, offset, len);
S
Stefan Hajnoczi 已提交
1340 1341
}

1342 1343 1344
static BlockAIOCB *qed_aio_setup(BlockDriverState *bs,
                                 int64_t sector_num,
                                 QEMUIOVector *qiov, int nb_sectors,
1345
                                 BlockCompletionFunc *cb,
1346
                                 void *opaque, int flags)
S
Stefan Hajnoczi 已提交
1347
{
S
Stefan Hajnoczi 已提交
1348
    QEDAIOCB *acb = qemu_aio_get(&qed_aiocb_info, bs, cb, opaque);
S
Stefan Hajnoczi 已提交
1349 1350

    trace_qed_aio_setup(bs->opaque, acb, sector_num, nb_sectors,
1351
                        opaque, flags);
S
Stefan Hajnoczi 已提交
1352

1353
    acb->flags = flags;
S
Stefan Hajnoczi 已提交
1354 1355 1356 1357
    acb->qiov = qiov;
    acb->qiov_offset = 0;
    acb->cur_pos = (uint64_t)sector_num * BDRV_SECTOR_SIZE;
    acb->end_pos = acb->cur_pos + nb_sectors * BDRV_SECTOR_SIZE;
1358
    acb->backing_qiov = NULL;
S
Stefan Hajnoczi 已提交
1359 1360 1361 1362
    acb->request.l2_table = NULL;
    qemu_iovec_init(&acb->cur_qiov, qiov->niov);

    /* Start request */
1363
    qed_aio_start_io(acb);
S
Stefan Hajnoczi 已提交
1364 1365 1366
    return &acb->common;
}

1367 1368 1369
static BlockAIOCB *bdrv_qed_aio_readv(BlockDriverState *bs,
                                      int64_t sector_num,
                                      QEMUIOVector *qiov, int nb_sectors,
1370
                                      BlockCompletionFunc *cb,
1371
                                      void *opaque)
1372
{
1373
    return qed_aio_setup(bs, sector_num, qiov, nb_sectors, cb, opaque, 0);
1374 1375
}

1376 1377 1378
static BlockAIOCB *bdrv_qed_aio_writev(BlockDriverState *bs,
                                       int64_t sector_num,
                                       QEMUIOVector *qiov, int nb_sectors,
1379
                                       BlockCompletionFunc *cb,
1380
                                       void *opaque)
1381
{
1382 1383
    return qed_aio_setup(bs, sector_num, qiov, nb_sectors, cb,
                         opaque, QED_AIOCB_WRITE);
1384 1385
}

1386 1387 1388 1389 1390 1391
typedef struct {
    Coroutine *co;
    int ret;
    bool done;
} QEDWriteZeroesCB;

1392
static void coroutine_fn qed_co_pwrite_zeroes_cb(void *opaque, int ret)
1393 1394 1395 1396 1397 1398
{
    QEDWriteZeroesCB *cb = opaque;

    cb->done = true;
    cb->ret = ret;
    if (cb->co) {
1399
        aio_co_wake(cb->co);
1400 1401 1402
    }
}

1403 1404 1405 1406
static int coroutine_fn bdrv_qed_co_pwrite_zeroes(BlockDriverState *bs,
                                                  int64_t offset,
                                                  int count,
                                                  BdrvRequestFlags flags)
1407
{
1408
    BlockAIOCB *blockacb;
1409
    BDRVQEDState *s = bs->opaque;
1410 1411 1412 1413
    QEDWriteZeroesCB cb = { .done = false };
    QEMUIOVector qiov;
    struct iovec iov;

1414 1415 1416 1417
    /* Fall back if the request is not aligned */
    if (qed_offset_into_cluster(s, offset) ||
        qed_offset_into_cluster(s, count)) {
        return -ENOTSUP;
1418 1419
    }

1420 1421 1422
    /* Zero writes start without an I/O buffer.  If a buffer becomes necessary
     * then it will be allocated during request processing.
     */
1423 1424
    iov.iov_base = NULL;
    iov.iov_len = count;
1425 1426

    qemu_iovec_init_external(&qiov, &iov, 1);
1427 1428 1429
    blockacb = qed_aio_setup(bs, offset >> BDRV_SECTOR_BITS, &qiov,
                             count >> BDRV_SECTOR_BITS,
                             qed_co_pwrite_zeroes_cb, &cb,
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441
                             QED_AIOCB_WRITE | QED_AIOCB_ZERO);
    if (!blockacb) {
        return -EIO;
    }
    if (!cb.done) {
        cb.co = qemu_coroutine_self();
        qemu_coroutine_yield();
    }
    assert(cb.done);
    return cb.ret;
}

1442
static int bdrv_qed_truncate(BlockDriverState *bs, int64_t offset, Error **errp)
1443
{
1444 1445 1446 1447 1448 1449
    BDRVQEDState *s = bs->opaque;
    uint64_t old_image_size;
    int ret;

    if (!qed_is_image_size_valid(offset, s->header.cluster_size,
                                 s->header.table_size)) {
1450
        error_setg(errp, "Invalid image size specified");
1451 1452 1453 1454
        return -EINVAL;
    }

    if ((uint64_t)offset < s->header.image_size) {
1455
        error_setg(errp, "Shrinking images is currently not supported");
1456 1457 1458 1459 1460 1461 1462 1463
        return -ENOTSUP;
    }

    old_image_size = s->header.image_size;
    s->header.image_size = offset;
    ret = qed_write_header_sync(s);
    if (ret < 0) {
        s->header.image_size = old_image_size;
1464
        error_setg_errno(errp, -ret, "Failed to update the image size");
1465 1466
    }
    return ret;
1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
}

static int64_t bdrv_qed_getlength(BlockDriverState *bs)
{
    BDRVQEDState *s = bs->opaque;
    return s->header.image_size;
}

static int bdrv_qed_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
{
    BDRVQEDState *s = bs->opaque;

    memset(bdi, 0, sizeof(*bdi));
    bdi->cluster_size = s->header.cluster_size;
D
Dong Xu Wang 已提交
1481
    bdi->is_dirty = s->header.features & QED_F_NEED_CHECK;
1482 1483
    bdi->unallocated_blocks_are_zero = true;
    bdi->can_write_zeroes_with_unmap = true;
1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538
    return 0;
}

static int bdrv_qed_change_backing_file(BlockDriverState *bs,
                                        const char *backing_file,
                                        const char *backing_fmt)
{
    BDRVQEDState *s = bs->opaque;
    QEDHeader new_header, le_header;
    void *buffer;
    size_t buffer_len, backing_file_len;
    int ret;

    /* Refuse to set backing filename if unknown compat feature bits are
     * active.  If the image uses an unknown compat feature then we may not
     * know the layout of data following the header structure and cannot safely
     * add a new string.
     */
    if (backing_file && (s->header.compat_features &
                         ~QED_COMPAT_FEATURE_MASK)) {
        return -ENOTSUP;
    }

    memcpy(&new_header, &s->header, sizeof(new_header));

    new_header.features &= ~(QED_F_BACKING_FILE |
                             QED_F_BACKING_FORMAT_NO_PROBE);

    /* Adjust feature flags */
    if (backing_file) {
        new_header.features |= QED_F_BACKING_FILE;

        if (qed_fmt_is_raw(backing_fmt)) {
            new_header.features |= QED_F_BACKING_FORMAT_NO_PROBE;
        }
    }

    /* Calculate new header size */
    backing_file_len = 0;

    if (backing_file) {
        backing_file_len = strlen(backing_file);
    }

    buffer_len = sizeof(new_header);
    new_header.backing_filename_offset = buffer_len;
    new_header.backing_filename_size = backing_file_len;
    buffer_len += backing_file_len;

    /* Make sure we can rewrite header without failing */
    if (buffer_len > new_header.header_size * new_header.cluster_size) {
        return -ENOSPC;
    }

    /* Prepare new header */
1539
    buffer = g_malloc(buffer_len);
1540 1541 1542 1543 1544

    qed_header_cpu_to_le(&new_header, &le_header);
    memcpy(buffer, &le_header, sizeof(le_header));
    buffer_len = sizeof(le_header);

P
Pavel Borzenkov 已提交
1545 1546 1547 1548
    if (backing_file) {
        memcpy(buffer + buffer_len, backing_file, backing_file_len);
        buffer_len += backing_file_len;
    }
1549 1550

    /* Write new header */
1551
    ret = bdrv_pwrite_sync(bs->file, 0, buffer, buffer_len);
1552
    g_free(buffer);
1553 1554 1555 1556 1557 1558
    if (ret == 0) {
        memcpy(&s->header, &new_header, sizeof(new_header));
    }
    return ret;
}

1559
static void bdrv_qed_invalidate_cache(BlockDriverState *bs, Error **errp)
1560 1561
{
    BDRVQEDState *s = bs->opaque;
1562 1563
    Error *local_err = NULL;
    int ret;
1564 1565

    bdrv_qed_close(bs);
1566

1567
    memset(s, 0, sizeof(BDRVQEDState));
1568
    ret = bdrv_qed_do_open(bs, NULL, bs->open_flags, &local_err);
1569
    if (local_err) {
1570 1571
        error_propagate(errp, local_err);
        error_prepend(errp, "Could not reopen qed layer: ");
1572 1573 1574 1575 1576
        return;
    } else if (ret < 0) {
        error_setg_errno(errp, -ret, "Could not reopen qed layer");
        return;
    }
1577 1578
}

1579 1580
static int bdrv_qed_check(BlockDriverState *bs, BdrvCheckResult *result,
                          BdrvCheckMode fix)
1581
{
S
Stefan Hajnoczi 已提交
1582 1583
    BDRVQEDState *s = bs->opaque;

1584
    return qed_check(s, result, !!fix);
1585 1586
}

1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618
static QemuOptsList qed_create_opts = {
    .name = "qed-create-opts",
    .head = QTAILQ_HEAD_INITIALIZER(qed_create_opts.head),
    .desc = {
        {
            .name = BLOCK_OPT_SIZE,
            .type = QEMU_OPT_SIZE,
            .help = "Virtual disk size"
        },
        {
            .name = BLOCK_OPT_BACKING_FILE,
            .type = QEMU_OPT_STRING,
            .help = "File name of a base image"
        },
        {
            .name = BLOCK_OPT_BACKING_FMT,
            .type = QEMU_OPT_STRING,
            .help = "Image format of the base image"
        },
        {
            .name = BLOCK_OPT_CLUSTER_SIZE,
            .type = QEMU_OPT_SIZE,
            .help = "Cluster size (in bytes)",
            .def_value_str = stringify(QED_DEFAULT_CLUSTER_SIZE)
        },
        {
            .name = BLOCK_OPT_TABLE_SIZE,
            .type = QEMU_OPT_SIZE,
            .help = "L1/L2 table size (in clusters)"
        },
        { /* end of list */ }
    }
1619 1620 1621 1622 1623
};

static BlockDriver bdrv_qed = {
    .format_name              = "qed",
    .instance_size            = sizeof(BDRVQEDState),
1624
    .create_opts              = &qed_create_opts,
1625
    .supports_backing         = true,
1626 1627 1628 1629

    .bdrv_probe               = bdrv_qed_probe,
    .bdrv_open                = bdrv_qed_open,
    .bdrv_close               = bdrv_qed_close,
J
Jeff Cody 已提交
1630
    .bdrv_reopen_prepare      = bdrv_qed_reopen_prepare,
1631
    .bdrv_child_perm          = bdrv_format_default_perms,
C
Chunyan Liu 已提交
1632
    .bdrv_create              = bdrv_qed_create,
1633
    .bdrv_has_zero_init       = bdrv_has_zero_init_1,
1634
    .bdrv_co_get_block_status = bdrv_qed_co_get_block_status,
1635 1636
    .bdrv_aio_readv           = bdrv_qed_aio_readv,
    .bdrv_aio_writev          = bdrv_qed_aio_writev,
1637
    .bdrv_co_pwrite_zeroes    = bdrv_qed_co_pwrite_zeroes,
1638 1639 1640
    .bdrv_truncate            = bdrv_qed_truncate,
    .bdrv_getlength           = bdrv_qed_getlength,
    .bdrv_get_info            = bdrv_qed_get_info,
1641
    .bdrv_refresh_limits      = bdrv_qed_refresh_limits,
1642
    .bdrv_change_backing_file = bdrv_qed_change_backing_file,
1643
    .bdrv_invalidate_cache    = bdrv_qed_invalidate_cache,
1644
    .bdrv_check               = bdrv_qed_check,
1645 1646
    .bdrv_detach_aio_context  = bdrv_qed_detach_aio_context,
    .bdrv_attach_aio_context  = bdrv_qed_attach_aio_context,
F
Fam Zheng 已提交
1647
    .bdrv_drain               = bdrv_qed_drain,
1648 1649 1650 1651 1652 1653 1654 1655
};

static void bdrv_qed_init(void)
{
    bdrv_register(&bdrv_qed);
}

block_init(bdrv_qed_init);