block/mirror.c

   1 /*
   2  * Image mirroring
   3  *
   4  * Copyright Red Hat, Inc. 2012
   5  *
   6  * Authors:
   7  *  Paolo Bonzini  <[email protected]>
   8  *
   9  * This work is licensed under the terms of the GNU LGPL, version 2 or later.
  10  * See the COPYING.LIB file in the top-level directory.
  11  *
  12  */
  13
  14 #include "qemu/osdep.h"
  15 #include "qemu/cutils.h"
  16 #include "trace.h"
  17 #include "block/blockjob_int.h"
  18 #include "block/block_int.h"
  19 #include "sysemu/block-backend.h"
  20 #include "qapi/error.h"
  21 #include "qapi/qmp/qerror.h"
  22 #include "qemu/ratelimit.h"
  23 #include "qemu/bitmap.h"
  24
  25 #define MAX_IN_FLIGHT 16
  26 #define MAX_IO_BYTES (1 << 20) /* 1 Mb */
  27 #define DEFAULT_MIRROR_BUF_SIZE (MAX_IN_FLIGHT * MAX_IO_BYTES)
  28
  29 /* The mirroring buffer is a list of granularity-sized chunks.
  30  * Free chunks are organized in a list.
  31  */
  32 typedef struct MirrorBuffer {
  33     QSIMPLEQ_ENTRY(MirrorBuffer) next;
  34 } MirrorBuffer;
  35
  36 typedef struct MirrorBlockJob {
  37     BlockJob common;
  38     BlockBackend *target;
  39     BlockDriverState *mirror_top_bs;
  40     BlockDriverState *source;
  41     BlockDriverState *base;
  42
  43     /* The name of the graph node to replace */
  44     char *replaces;
  45     /* The BDS to replace */
  46     BlockDriverState *to_replace;
  47     /* Used to block operations on the drive-mirror-replace target */
  48     Error *replace_blocker;
  49     bool is_none_mode;
  50     BlockMirrorBackingMode backing_mode;
  51     BlockdevOnError on_source_error, on_target_error;
  52     bool synced;
  53     bool should_complete;
  54     int64_t granularity;
  55     size_t buf_size;
  56     int64_t bdev_length;
  57     unsigned long *cow_bitmap;
  58     BdrvDirtyBitmap *dirty_bitmap;
  59     BdrvDirtyBitmapIter *dbi;
  60     uint8_t *buf;
  61     QSIMPLEQ_HEAD(, MirrorBuffer) buf_free;
  62     int buf_free_count;
  63
  64     uint64_t last_pause_ns;
  65     unsigned long *in_flight_bitmap;
  66     int in_flight;
  67     int64_t bytes_in_flight;
  68     int ret;
  69     bool unmap;
  70     bool waiting_for_io;
  71     int target_cluster_size;
  72     int max_iov;
  73     bool initial_zeroing_ongoing;
  74 } MirrorBlockJob;
  75
  76 typedef struct MirrorOp {
  77     MirrorBlockJob *s;
  78     QEMUIOVector qiov;
  79     int64_t offset;
  80     uint64_t bytes;
  81 } MirrorOp;
  82
  83 static BlockErrorAction mirror_error_action(MirrorBlockJob *s, bool read,
  84                                             int error)
  85 {
  86     s->synced = false;
  87     if (read) {
  88         return block_job_error_action(&s->common, s->on_source_error,
  89                                       true, error);
  90     } else {
  91         return block_job_error_action(&s->common, s->on_target_error,
  92                                       false, error);
  93     }
  94 }
  95
  96 static void mirror_iteration_done(MirrorOp *op, int ret)
  97 {
  98     MirrorBlockJob *s = op->s;
  99     struct iovec *iov;
 100     int64_t chunk_num;
 101     int i, nb_chunks;
 102
 103     trace_mirror_iteration_done(s, op->offset, op->bytes, ret);
 104
 105     s->in_flight--;
 106     s->bytes_in_flight -= op->bytes;
 107     iov = op->qiov.iov;
 108     for (i = 0; i < op->qiov.niov; i++) {
 109         MirrorBuffer *buf = (MirrorBuffer *) iov[i].iov_base;
 110         QSIMPLEQ_INSERT_TAIL(&s->buf_free, buf, next);
 111         s->buf_free_count++;
 112     }
 113
 114     chunk_num = op->offset / s->granularity;
 115     nb_chunks = DIV_ROUND_UP(op->bytes, s->granularity);
 116     bitmap_clear(s->in_flight_bitmap, chunk_num, nb_chunks);
 117     if (ret >= 0) {
 118         if (s->cow_bitmap) {
 119             bitmap_set(s->cow_bitmap, chunk_num, nb_chunks);
 120         }
 121         if (!s->initial_zeroing_ongoing) {
 122             block_job_progress_update(&s->common, op->bytes);
 123         }
 124     }
 125     qemu_iovec_destroy(&op->qiov);
 126     g_free(op);
 127
 128     if (s->waiting_for_io) {
 129         qemu_coroutine_enter(s->common.co);
 130     }
 131 }
 132
 133 static void mirror_write_complete(void *opaque, int ret)
 134 {
 135     MirrorOp *op = opaque;
 136     MirrorBlockJob *s = op->s;
 137
 138     aio_context_acquire(blk_get_aio_context(s->common.blk));
 139     if (ret < 0) {
 140         BlockErrorAction action;
 141
 142         bdrv_set_dirty_bitmap(s->dirty_bitmap, op->offset, op->bytes);
 143         action = mirror_error_action(s, false, -ret);
 144         if (action == BLOCK_ERROR_ACTION_REPORT && s->ret >= 0) {
 145             s->ret = ret;
 146         }
 147     }
 148     mirror_iteration_done(op, ret);
 149     aio_context_release(blk_get_aio_context(s->common.blk));
 150 }
 151
 152 static void mirror_read_complete(void *opaque, int ret)
 153 {
 154     MirrorOp *op = opaque;
 155     MirrorBlockJob *s = op->s;
 156
 157     aio_context_acquire(blk_get_aio_context(s->common.blk));
 158     if (ret < 0) {
 159         BlockErrorAction action;
 160
 161         bdrv_set_dirty_bitmap(s->dirty_bitmap, op->offset, op->bytes);
 162         action = mirror_error_action(s, true, -ret);
 163         if (action == BLOCK_ERROR_ACTION_REPORT && s->ret >= 0) {
 164             s->ret = ret;
 165         }
 166
 167         mirror_iteration_done(op, ret);
 168     } else {
 169         blk_aio_pwritev(s->target, op->offset, &op->qiov,
 170                         0, mirror_write_complete, op);
 171     }
 172     aio_context_release(blk_get_aio_context(s->common.blk));
 173 }
 174
 175 /* Clip bytes relative to offset to not exceed end-of-file */
 176 static inline int64_t mirror_clip_bytes(MirrorBlockJob *s,
 177                                         int64_t offset,
 178                                         int64_t bytes)
 179 {
 180     return MIN(bytes, s->bdev_length - offset);
 181 }
 182
 183 /* Round offset and/or bytes to target cluster if COW is needed, and
 184  * return the offset of the adjusted tail against original. */
 185 static int mirror_cow_align(MirrorBlockJob *s, int64_t *offset,
 186                             uint64_t *bytes)
 187 {
 188     bool need_cow;
 189     int ret = 0;
 190     int64_t align_offset = *offset;
 191     int64_t align_bytes = *bytes;
 192     int max_bytes = s->granularity * s->max_iov;
 193
 194     need_cow = !test_bit(*offset / s->granularity, s->cow_bitmap);
 195     need_cow |= !test_bit((*offset + *bytes - 1) / s->granularity,
 196                           s->cow_bitmap);
 197     if (need_cow) {
 198         bdrv_round_to_clusters(blk_bs(s->target), *offset, *bytes,
 199                                &align_offset, &align_bytes);
 200     }
 201
 202     if (align_bytes > max_bytes) {
 203         align_bytes = max_bytes;
 204         if (need_cow) {
 205             align_bytes = QEMU_ALIGN_DOWN(align_bytes, s->target_cluster_size);
 206         }
 207     }
 208     /* Clipping may result in align_bytes unaligned to chunk boundary, but
 209      * that doesn't matter because it's already the end of source image. */
 210     align_bytes = mirror_clip_bytes(s, align_offset, align_bytes);
 211
 212     ret = align_offset + align_bytes - (*offset + *bytes);
 213     *offset = align_offset;
 214     *bytes = align_bytes;
 215     assert(ret >= 0);
 216     return ret;
 217 }
 218
 219 static inline void mirror_wait_for_io(MirrorBlockJob *s)
 220 {
 221     assert(!s->waiting_for_io);
 222     s->waiting_for_io = true;
 223     qemu_coroutine_yield();
 224     s->waiting_for_io = false;
 225 }
 226
 227 /* Submit async read while handling COW.
 228  * Returns: The number of bytes copied after and including offset,
 229  *          excluding any bytes copied prior to offset due to alignment.
 230  *          This will be @bytes if no alignment is necessary, or
 231  *          (new_end - offset) if tail is rounded up or down due to
 232  *          alignment or buffer limit.
 233  */
 234 static uint64_t mirror_do_read(MirrorBlockJob *s, int64_t offset,
 235                                uint64_t bytes)
 236 {
 237     BlockBackend *source = s->common.blk;
 238     int nb_chunks;
 239     uint64_t ret;
 240     MirrorOp *op;
 241     uint64_t max_bytes;
 242
 243     max_bytes = s->granularity * s->max_iov;
 244
 245     /* We can only handle as much as buf_size at a time. */
 246     bytes = MIN(s->buf_size, MIN(max_bytes, bytes));
 247     assert(bytes);
 248     assert(bytes < BDRV_REQUEST_MAX_BYTES);
 249     ret = bytes;
 250
 251     if (s->cow_bitmap) {
 252         ret += mirror_cow_align(s, &offset, &bytes);
 253     }
 254     assert(bytes <= s->buf_size);
 255     /* The offset is granularity-aligned because:
 256      * 1) Caller passes in aligned values;
 257      * 2) mirror_cow_align is used only when target cluster is larger. */
 258     assert(QEMU_IS_ALIGNED(offset, s->granularity));
 259     /* The range is sector-aligned, since bdrv_getlength() rounds up. */
 260     assert(QEMU_IS_ALIGNED(bytes, BDRV_SECTOR_SIZE));
 261     nb_chunks = DIV_ROUND_UP(bytes, s->granularity);
 262
 263     while (s->buf_free_count < nb_chunks) {
 264         trace_mirror_yield_in_flight(s, offset, s->in_flight);
 265         mirror_wait_for_io(s);
 266     }
 267
 268     /* Allocate a MirrorOp that is used as an AIO callback.  */
 269     op = g_new(MirrorOp, 1);
 270     op->s = s;
 271     op->offset = offset;
 272     op->bytes = bytes;
 273
 274     /* Now make a QEMUIOVector taking enough granularity-sized chunks
 275      * from s->buf_free.
 276      */
 277     qemu_iovec_init(&op->qiov, nb_chunks);
 278     while (nb_chunks-- > 0) {
 279         MirrorBuffer *buf = QSIMPLEQ_FIRST(&s->buf_free);
 280         size_t remaining = bytes - op->qiov.size;
 281
 282         QSIMPLEQ_REMOVE_HEAD(&s->buf_free, next);
 283         s->buf_free_count--;
 284         qemu_iovec_add(&op->qiov, buf, MIN(s->granularity, remaining));
 285     }
 286
 287     /* Copy the dirty cluster.  */
 288     s->in_flight++;
 289     s->bytes_in_flight += bytes;
 290     trace_mirror_one_iteration(s, offset, bytes);
 291
 292     blk_aio_preadv(source, offset, &op->qiov, 0, mirror_read_complete, op);
 293     return ret;
 294 }
 295
 296 static void mirror_do_zero_or_discard(MirrorBlockJob *s,
 297                                       int64_t offset,
 298                                       uint64_t bytes,
 299                                       bool is_discard)
 300 {
 301     MirrorOp *op;
 302
 303     /* Allocate a MirrorOp that is used as an AIO callback. The qiov is zeroed
 304      * so the freeing in mirror_iteration_done is nop. */
 305     op = g_new0(MirrorOp, 1);
 306     op->s = s;
 307     op->offset = offset;
 308     op->bytes = bytes;
 309
 310     s->in_flight++;
 311     s->bytes_in_flight += bytes;
 312     if (is_discard) {
 313         blk_aio_pdiscard(s->target, offset,
 314                          op->bytes, mirror_write_complete, op);
 315     } else {
 316         blk_aio_pwrite_zeroes(s->target, offset,
 317                               op->bytes, s->unmap ? BDRV_REQ_MAY_UNMAP : 0,
 318                               mirror_write_complete, op);
 319     }
 320 }
 321
 322 static uint64_t coroutine_fn mirror_iteration(MirrorBlockJob *s)
 323 {
 324     BlockDriverState *source = s->source;
 325     int64_t offset, first_chunk;
 326     uint64_t delay_ns = 0;
 327     /* At least the first dirty chunk is mirrored in one iteration. */
 328     int nb_chunks = 1;
 329     bool write_zeroes_ok = bdrv_can_write_zeroes_with_unmap(blk_bs(s->target));
 330     int max_io_bytes = MAX(s->buf_size / MAX_IN_FLIGHT, MAX_IO_BYTES);
 331
 332     bdrv_dirty_bitmap_lock(s->dirty_bitmap);
 333     offset = bdrv_dirty_iter_next(s->dbi);
 334     if (offset < 0) {
 335         bdrv_set_dirty_iter(s->dbi, 0);
 336         offset = bdrv_dirty_iter_next(s->dbi);
 337         trace_mirror_restart_iter(s, bdrv_get_dirty_count(s->dirty_bitmap));
 338         assert(offset >= 0);
 339     }
 340     bdrv_dirty_bitmap_unlock(s->dirty_bitmap);
 341
 342     first_chunk = offset / s->granularity;
 343     while (test_bit(first_chunk, s->in_flight_bitmap)) {
 344         trace_mirror_yield_in_flight(s, offset, s->in_flight);
 345         mirror_wait_for_io(s);
 346     }
 347
 348     block_job_pause_point(&s->common);
 349
 350     /* Find the number of consective dirty chunks following the first dirty
 351      * one, and wait for in flight requests in them. */
 352     bdrv_dirty_bitmap_lock(s->dirty_bitmap);
 353     while (nb_chunks * s->granularity < s->buf_size) {
 354         int64_t next_dirty;
 355         int64_t next_offset = offset + nb_chunks * s->granularity;
 356         int64_t next_chunk = next_offset / s->granularity;
 357         if (next_offset >= s->bdev_length ||
 358             !bdrv_get_dirty_locked(source, s->dirty_bitmap, next_offset)) {
 359             break;
 360         }
 361         if (test_bit(next_chunk, s->in_flight_bitmap)) {
 362             break;
 363         }
 364
 365         next_dirty = bdrv_dirty_iter_next(s->dbi);
 366         if (next_dirty > next_offset || next_dirty < 0) {
 367             /* The bitmap iterator's cache is stale, refresh it */
 368             bdrv_set_dirty_iter(s->dbi, next_offset);
 369             next_dirty = bdrv_dirty_iter_next(s->dbi);
 370         }
 371         assert(next_dirty == next_offset);
 372         nb_chunks++;
 373     }
 374
 375     /* Clear dirty bits before querying the block status, because
 376      * calling bdrv_block_status_above could yield - if some blocks are
 377      * marked dirty in this window, we need to know.
 378      */
 379     bdrv_reset_dirty_bitmap_locked(s->dirty_bitmap, offset,
 380                                    nb_chunks * s->granularity);
 381     bdrv_dirty_bitmap_unlock(s->dirty_bitmap);
 382
 383     bitmap_set(s->in_flight_bitmap, offset / s->granularity, nb_chunks);
 384     while (nb_chunks > 0 && offset < s->bdev_length) {
 385         int ret;
 386         int64_t io_bytes;
 387         int64_t io_bytes_acct;
 388         enum MirrorMethod {
 389             MIRROR_METHOD_COPY,
 390             MIRROR_METHOD_ZERO,
 391             MIRROR_METHOD_DISCARD
 392         } mirror_method = MIRROR_METHOD_COPY;
 393
 394         assert(!(offset % s->granularity));
 395         ret = bdrv_block_status_above(source, NULL, offset,
 396                                       nb_chunks * s->granularity,
 397                                       &io_bytes, NULL, NULL);
 398         if (ret < 0) {
 399             io_bytes = MIN(nb_chunks * s->granularity, max_io_bytes);
 400         } else if (ret & BDRV_BLOCK_DATA) {
 401             io_bytes = MIN(io_bytes, max_io_bytes);
 402         }
 403
 404         io_bytes -= io_bytes % s->granularity;
 405         if (io_bytes < s->granularity) {
 406             io_bytes = s->granularity;
 407         } else if (ret >= 0 && !(ret & BDRV_BLOCK_DATA)) {
 408             int64_t target_offset;
 409             int64_t target_bytes;
 410             bdrv_round_to_clusters(blk_bs(s->target), offset, io_bytes,
 411                                    &target_offset, &target_bytes);
 412             if (target_offset == offset &&
 413                 target_bytes == io_bytes) {
 414                 mirror_method = ret & BDRV_BLOCK_ZERO ?
 415                                     MIRROR_METHOD_ZERO :
 416                                     MIRROR_METHOD_DISCARD;
 417             }
 418         }
 419
 420         while (s->in_flight >= MAX_IN_FLIGHT) {
 421             trace_mirror_yield_in_flight(s, offset, s->in_flight);
 422             mirror_wait_for_io(s);
 423         }
 424
 425         if (s->ret < 0) {
 426             return 0;
 427         }
 428
 429         io_bytes = mirror_clip_bytes(s, offset, io_bytes);
 430         switch (mirror_method) {
 431         case MIRROR_METHOD_COPY:
 432             io_bytes = io_bytes_acct = mirror_do_read(s, offset, io_bytes);
 433             break;
 434         case MIRROR_METHOD_ZERO:
 435         case MIRROR_METHOD_DISCARD:
 436             mirror_do_zero_or_discard(s, offset, io_bytes,
 437                                       mirror_method == MIRROR_METHOD_DISCARD);
 438             if (write_zeroes_ok) {
 439                 io_bytes_acct = 0;
 440             } else {
 441                 io_bytes_acct = io_bytes;
 442             }
 443             break;
 444         default:
 445             abort();
 446         }
 447         assert(io_bytes);
 448         offset += io_bytes;
 449         nb_chunks -= DIV_ROUND_UP(io_bytes, s->granularity);
 450         delay_ns = block_job_ratelimit_get_delay(&s->common, io_bytes_acct);
 451     }
 452     return delay_ns;
 453 }
 454
 455 static void mirror_free_init(MirrorBlockJob *s)
 456 {
 457     int granularity = s->granularity;
 458     size_t buf_size = s->buf_size;
 459     uint8_t *buf = s->buf;
 460
 461     assert(s->buf_free_count == 0);
 462     QSIMPLEQ_INIT(&s->buf_free);
 463     while (buf_size != 0) {
 464         MirrorBuffer *cur = (MirrorBuffer *)buf;
 465         QSIMPLEQ_INSERT_TAIL(&s->buf_free, cur, next);
 466         s->buf_free_count++;
 467         buf_size -= granularity;
 468         buf += granularity;
 469     }
 470 }
 471
 472 /* This is also used for the .pause callback. There is no matching
 473  * mirror_resume() because mirror_run() will begin iterating again
 474  * when the job is resumed.
 475  */
 476 static void mirror_wait_for_all_io(MirrorBlockJob *s)
 477 {
 478     while (s->in_flight > 0) {
 479         mirror_wait_for_io(s);
 480     }
 481 }
 482
 483 typedef struct {
 484     int ret;
 485 } MirrorExitData;
 486
 487 static void mirror_exit(BlockJob *job, void *opaque)
 488 {
 489     MirrorBlockJob *s = container_of(job, MirrorBlockJob, common);
 490     MirrorExitData *data = opaque;
 491     AioContext *replace_aio_context = NULL;
 492     BlockDriverState *src = s->source;
 493     BlockDriverState *target_bs = blk_bs(s->target);
 494     BlockDriverState *mirror_top_bs = s->mirror_top_bs;
 495     Error *local_err = NULL;
 496
 497     bdrv_release_dirty_bitmap(src, s->dirty_bitmap);
 498
 499     /* Make sure that the source BDS doesn't go away before we called
 500      * block_job_completed(). */
 501     bdrv_ref(src);
 502     bdrv_ref(mirror_top_bs);
 503     bdrv_ref(target_bs);
 504
 505     /* Remove target parent that still uses BLK_PERM_WRITE/RESIZE before
 506      * inserting target_bs at s->to_replace, where we might not be able to get
 507      * these permissions.
 508      *
 509      * Note that blk_unref() alone doesn't necessarily drop permissions because
 510      * we might be running nested inside mirror_drain(), which takes an extra
 511      * reference, so use an explicit blk_set_perm() first. */
 512     blk_set_perm(s->target, 0, BLK_PERM_ALL, &error_abort);
 513     blk_unref(s->target);
 514     s->target = NULL;
 515
 516     /* We don't access the source any more. Dropping any WRITE/RESIZE is
 517      * required before it could become a backing file of target_bs. */
 518     bdrv_child_try_set_perm(mirror_top_bs->backing, 0, BLK_PERM_ALL,
 519                             &error_abort);
 520     if (s->backing_mode == MIRROR_SOURCE_BACKING_CHAIN) {
 521         BlockDriverState *backing = s->is_none_mode ? src : s->base;
 522         if (backing_bs(target_bs) != backing) {
 523             bdrv_set_backing_hd(target_bs, backing, &local_err);
 524             if (local_err) {
 525                 error_report_err(local_err);
 526                 data->ret = -EPERM;
 527             }
 528         }
 529     }
 530
 531     if (s->to_replace) {
 532         replace_aio_context = bdrv_get_aio_context(s->to_replace);
 533         aio_context_acquire(replace_aio_context);
 534     }
 535
 536     if (s->should_complete && data->ret == 0) {
 537         BlockDriverState *to_replace = src;
 538         if (s->to_replace) {
 539             to_replace = s->to_replace;
 540         }
 541
 542         if (bdrv_get_flags(target_bs) != bdrv_get_flags(to_replace)) {
 543             bdrv_reopen(target_bs, bdrv_get_flags(to_replace), NULL);
 544         }
 545
 546         /* The mirror job has no requests in flight any more, but we need to
 547          * drain potential other users of the BDS before changing the graph. */
 548         bdrv_drained_begin(target_bs);
 549         bdrv_replace_node(to_replace, target_bs, &local_err);
 550         bdrv_drained_end(target_bs);
 551         if (local_err) {
 552             error_report_err(local_err);
 553             data->ret = -EPERM;
 554         }
 555     }
 556     if (s->to_replace) {
 557         bdrv_op_unblock_all(s->to_replace, s->replace_blocker);
 558         error_free(s->replace_blocker);
 559         bdrv_unref(s->to_replace);
 560     }
 561     if (replace_aio_context) {
 562         aio_context_release(replace_aio_context);
 563     }
 564     g_free(s->replaces);
 565     bdrv_unref(target_bs);
 566
 567     /* Remove the mirror filter driver from the graph. Before this, get rid of
 568      * the blockers on the intermediate nodes so that the resulting state is
 569      * valid. Also give up permissions on mirror_top_bs->backing, which might
 570      * block the removal. */
 571     block_job_remove_all_bdrv(job);
 572     bdrv_child_try_set_perm(mirror_top_bs->backing, 0, BLK_PERM_ALL,
 573                             &error_abort);
 574     bdrv_replace_node(mirror_top_bs, backing_bs(mirror_top_bs), &error_abort);
 575
 576     /* We just changed the BDS the job BB refers to (with either or both of the
 577      * bdrv_replace_node() calls), so switch the BB back so the cleanup does
 578      * the right thing. We don't need any permissions any more now. */
 579     blk_remove_bs(job->blk);
 580     blk_set_perm(job->blk, 0, BLK_PERM_ALL, &error_abort);
 581     blk_insert_bs(job->blk, mirror_top_bs, &error_abort);
 582
 583     block_job_completed(&s->common, data->ret);
 584
 585     g_free(data);
 586     bdrv_drained_end(src);
 587     bdrv_unref(mirror_top_bs);
 588     bdrv_unref(src);
 589 }
 590
 591 static void mirror_throttle(MirrorBlockJob *s)
 592 {
 593     int64_t now = qemu_clock_get_ns(QEMU_CLOCK_REALTIME);
 594
 595     if (now - s->last_pause_ns > BLOCK_JOB_SLICE_TIME) {
 596         s->last_pause_ns = now;
 597         block_job_sleep_ns(&s->common, 0);
 598     } else {
 599         block_job_pause_point(&s->common);
 600     }
 601 }
 602
 603 static int coroutine_fn mirror_dirty_init(MirrorBlockJob *s)
 604 {
 605     int64_t offset;
 606     BlockDriverState *base = s->base;
 607     BlockDriverState *bs = s->source;
 608     BlockDriverState *target_bs = blk_bs(s->target);
 609     int ret;
 610     int64_t count;
 611
 612     if (base == NULL && !bdrv_has_zero_init(target_bs)) {
 613         if (!bdrv_can_write_zeroes_with_unmap(target_bs)) {
 614             bdrv_set_dirty_bitmap(s->dirty_bitmap, 0, s->bdev_length);
 615             return 0;
 616         }
 617
 618         s->initial_zeroing_ongoing = true;
 619         for (offset = 0; offset < s->bdev_length; ) {
 620             int bytes = MIN(s->bdev_length - offset,
 621                             QEMU_ALIGN_DOWN(INT_MAX, s->granularity));
 622
 623             mirror_throttle(s);
 624
 625             if (block_job_is_cancelled(&s->common)) {
 626                 s->initial_zeroing_ongoing = false;
 627                 return 0;
 628             }
 629
 630             if (s->in_flight >= MAX_IN_FLIGHT) {
 631                 trace_mirror_yield(s, UINT64_MAX, s->buf_free_count,
 632                                    s->in_flight);
 633                 mirror_wait_for_io(s);
 634                 continue;
 635             }
 636
 637             mirror_do_zero_or_discard(s, offset, bytes, false);
 638             offset += bytes;
 639         }
 640
 641         mirror_wait_for_all_io(s);
 642         s->initial_zeroing_ongoing = false;
 643     }
 644
 645     /* First part, loop on the sectors and initialize the dirty bitmap.  */
 646     for (offset = 0; offset < s->bdev_length; ) {
 647         /* Just to make sure we are not exceeding int limit. */
 648         int bytes = MIN(s->bdev_length - offset,
 649                         QEMU_ALIGN_DOWN(INT_MAX, s->granularity));
 650
 651         mirror_throttle(s);
 652
 653         if (block_job_is_cancelled(&s->common)) {
 654             return 0;
 655         }
 656
 657         ret = bdrv_is_allocated_above(bs, base, offset, bytes, &count);
 658         if (ret < 0) {
 659             return ret;
 660         }
 661
 662         assert(count);
 663         if (ret == 1) {
 664             bdrv_set_dirty_bitmap(s->dirty_bitmap, offset, count);
 665         }
 666         offset += count;
 667     }
 668     return 0;
 669 }
 670
 671 /* Called when going out of the streaming phase to flush the bulk of the
 672  * data to the medium, or just before completing.
 673  */
 674 static int mirror_flush(MirrorBlockJob *s)
 675 {
 676     int ret = blk_flush(s->target);
 677     if (ret < 0) {
 678         if (mirror_error_action(s, false, -ret) == BLOCK_ERROR_ACTION_REPORT) {
 679             s->ret = ret;
 680         }
 681     }
 682     return ret;
 683 }
 684
 685 static void coroutine_fn mirror_run(void *opaque)
 686 {
 687     MirrorBlockJob *s = opaque;
 688     MirrorExitData *data;
 689     BlockDriverState *bs = s->source;
 690     BlockDriverState *target_bs = blk_bs(s->target);
 691     bool need_drain = true;
 692     int64_t length;
 693     BlockDriverInfo bdi;
 694     char backing_filename[2]; /* we only need 2 characters because we are only
 695                                  checking for a NULL string */
 696     int ret = 0;
 697
 698     if (block_job_is_cancelled(&s->common)) {
 699         goto immediate_exit;
 700     }
 701
 702     s->bdev_length = bdrv_getlength(bs);
 703     if (s->bdev_length < 0) {
 704         ret = s->bdev_length;
 705         goto immediate_exit;
 706     }
 707
 708     /* Active commit must resize the base image if its size differs from the
 709      * active layer. */
 710     if (s->base == blk_bs(s->target)) {
 711         int64_t base_length;
 712
 713         base_length = blk_getlength(s->target);
 714         if (base_length < 0) {
 715             ret = base_length;
 716             goto immediate_exit;
 717         }
 718
 719         if (s->bdev_length > base_length) {
 720             ret = blk_truncate(s->target, s->bdev_length, PREALLOC_MODE_OFF,
 721                                NULL);
 722             if (ret < 0) {
 723                 goto immediate_exit;
 724             }
 725         }
 726     }
 727
 728     if (s->bdev_length == 0) {
 729         /* Report BLOCK_JOB_READY and wait for complete. */
 730         block_job_event_ready(&s->common);
 731         s->synced = true;
 732         while (!block_job_is_cancelled(&s->common) && !s->should_complete) {
 733             block_job_yield(&s->common);
 734         }
 735         s->common.cancelled = false;
 736         goto immediate_exit;
 737     }
 738
 739     length = DIV_ROUND_UP(s->bdev_length, s->granularity);
 740     s->in_flight_bitmap = bitmap_new(length);
 741
 742     /* If we have no backing file yet in the destination, we cannot let
 743      * the destination do COW.  Instead, we copy sectors around the
 744      * dirty data if needed.  We need a bitmap to do that.
 745      */
 746     bdrv_get_backing_filename(target_bs, backing_filename,
 747                               sizeof(backing_filename));
 748     if (!bdrv_get_info(target_bs, &bdi) && bdi.cluster_size) {
 749         s->target_cluster_size = bdi.cluster_size;
 750     } else {
 751         s->target_cluster_size = BDRV_SECTOR_SIZE;
 752     }
 753     if (backing_filename[0] && !target_bs->backing &&
 754         s->granularity < s->target_cluster_size) {
 755         s->buf_size = MAX(s->buf_size, s->target_cluster_size);
 756         s->cow_bitmap = bitmap_new(length);
 757     }
 758     s->max_iov = MIN(bs->bl.max_iov, target_bs->bl.max_iov);
 759
 760     s->buf = qemu_try_blockalign(bs, s->buf_size);
 761     if (s->buf == NULL) {
 762         ret = -ENOMEM;
 763         goto immediate_exit;
 764     }
 765
 766     mirror_free_init(s);
 767
 768     s->last_pause_ns = qemu_clock_get_ns(QEMU_CLOCK_REALTIME);
 769     if (!s->is_none_mode) {
 770         ret = mirror_dirty_init(s);
 771         if (ret < 0 || block_job_is_cancelled(&s->common)) {
 772             goto immediate_exit;
 773         }
 774     }
 775
 776     assert(!s->dbi);
 777     s->dbi = bdrv_dirty_iter_new(s->dirty_bitmap);
 778     for (;;) {
 779         uint64_t delay_ns = 0;
 780         int64_t cnt, delta;
 781         bool should_complete;
 782
 783         if (s->ret < 0) {
 784             ret = s->ret;
 785             goto immediate_exit;
 786         }
 787
 788         block_job_pause_point(&s->common);
 789
 790         cnt = bdrv_get_dirty_count(s->dirty_bitmap);
 791         /* cnt is the number of dirty bytes remaining and s->bytes_in_flight is
 792          * the number of bytes currently being processed; together those are
 793          * the current remaining operation length */
 794         block_job_progress_set_remaining(&s->common, s->bytes_in_flight + cnt);
 795
 796         /* Note that even when no rate limit is applied we need to yield
 797          * periodically with no pending I/O so that bdrv_drain_all() returns.
 798          * We do so every BLKOCK_JOB_SLICE_TIME nanoseconds, or when there is
 799          * an error, or when the source is clean, whichever comes first. */
 800         delta = qemu_clock_get_ns(QEMU_CLOCK_REALTIME) - s->last_pause_ns;
 801         if (delta < BLOCK_JOB_SLICE_TIME &&
 802             s->common.iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
 803             if (s->in_flight >= MAX_IN_FLIGHT || s->buf_free_count == 0 ||
 804                 (cnt == 0 && s->in_flight > 0)) {
 805                 trace_mirror_yield(s, cnt, s->buf_free_count, s->in_flight);
 806                 mirror_wait_for_io(s);
 807                 continue;
 808             } else if (cnt != 0) {
 809                 delay_ns = mirror_iteration(s);
 810             }
 811         }
 812
 813         should_complete = false;
 814         if (s->in_flight == 0 && cnt == 0) {
 815             trace_mirror_before_flush(s);
 816             if (!s->synced) {
 817                 if (mirror_flush(s) < 0) {
 818                     /* Go check s->ret.  */
 819                     continue;
 820                 }
 821                 /* We're out of the streaming phase.  From now on, if the job
 822                  * is cancelled we will actually complete all pending I/O and
 823                  * report completion.  This way, block-job-cancel will leave
 824                  * the target in a consistent state.
 825                  */
 826                 block_job_event_ready(&s->common);
 827                 s->synced = true;
 828             }
 829
 830             should_complete = s->should_complete ||
 831                 block_job_is_cancelled(&s->common);
 832             cnt = bdrv_get_dirty_count(s->dirty_bitmap);
 833         }
 834
 835         if (cnt == 0 && should_complete) {
 836             /* The dirty bitmap is not updated while operations are pending.
 837              * If we're about to exit, wait for pending operations before
 838              * calling bdrv_get_dirty_count(bs), or we may exit while the
 839              * source has dirty data to copy!
 840              *
 841              * Note that I/O can be submitted by the guest while
 842              * mirror_populate runs, so pause it now.  Before deciding
 843              * whether to switch to target check one last time if I/O has
 844              * come in the meanwhile, and if not flush the data to disk.
 845              */
 846             trace_mirror_before_drain(s, cnt);
 847
 848             bdrv_drained_begin(bs);
 849             cnt = bdrv_get_dirty_count(s->dirty_bitmap);
 850             if (cnt > 0 || mirror_flush(s) < 0) {
 851                 bdrv_drained_end(bs);
 852                 continue;
 853             }
 854
 855             /* The two disks are in sync.  Exit and report successful
 856              * completion.
 857              */
 858             assert(QLIST_EMPTY(&bs->tracked_requests));
 859             s->common.cancelled = false;
 860             need_drain = false;
 861             break;
 862         }
 863
 864         ret = 0;
 865
 866         if (s->synced && !should_complete) {
 867             delay_ns = (s->in_flight == 0 &&
 868                         cnt == 0 ? BLOCK_JOB_SLICE_TIME : 0);
 869         }
 870         trace_mirror_before_sleep(s, cnt, s->synced, delay_ns);
 871         block_job_sleep_ns(&s->common, delay_ns);
 872         if (block_job_is_cancelled(&s->common) &&
 873             (!s->synced || s->common.force))
 874         {
 875             break;
 876         }
 877         s->last_pause_ns = qemu_clock_get_ns(QEMU_CLOCK_REALTIME);
 878     }
 879
 880 immediate_exit:
 881     if (s->in_flight > 0) {
 882         /* We get here only if something went wrong.  Either the job failed,
 883          * or it was cancelled prematurely so that we do not guarantee that
 884          * the target is a copy of the source.
 885          */
 886         assert(ret < 0 || ((s->common.force || !s->synced) &&
 887                block_job_is_cancelled(&s->common)));
 888         assert(need_drain);
 889         mirror_wait_for_all_io(s);
 890     }
 891
 892     assert(s->in_flight == 0);
 893     qemu_vfree(s->buf);
 894     g_free(s->cow_bitmap);
 895     g_free(s->in_flight_bitmap);
 896     bdrv_dirty_iter_free(s->dbi);
 897
 898     data = g_malloc(sizeof(*data));
 899     data->ret = ret;
 900
 901     if (need_drain) {
 902         bdrv_drained_begin(bs);
 903     }
 904     block_job_defer_to_main_loop(&s->common, mirror_exit, data);
 905 }
 906
 907 static void mirror_complete(BlockJob *job, Error **errp)
 908 {
 909     MirrorBlockJob *s = container_of(job, MirrorBlockJob, common);
 910     BlockDriverState *target;
 911
 912     target = blk_bs(s->target);
 913
 914     if (!s->synced) {
 915         error_setg(errp, "The active block job '%s' cannot be completed",
 916                    job->job.id);
 917         return;
 918     }
 919
 920     if (s->backing_mode == MIRROR_OPEN_BACKING_CHAIN) {
 921         int ret;
 922
 923         assert(!target->backing);
 924         ret = bdrv_open_backing_file(target, NULL, "backing", errp);
 925         if (ret < 0) {
 926             return;
 927         }
 928     }
 929
 930     /* block all operations on to_replace bs */
 931     if (s->replaces) {
 932         AioContext *replace_aio_context;
 933
 934         s->to_replace = bdrv_find_node(s->replaces);
 935         if (!s->to_replace) {
 936             error_setg(errp, "Node name '%s' not found", s->replaces);
 937             return;
 938         }
 939
 940         replace_aio_context = bdrv_get_aio_context(s->to_replace);
 941         aio_context_acquire(replace_aio_context);
 942
 943         /* TODO Translate this into permission system. Current definition of
 944          * GRAPH_MOD would require to request it for the parents; they might
 945          * not even be BlockDriverStates, however, so a BdrvChild can't address
 946          * them. May need redefinition of GRAPH_MOD. */
 947         error_setg(&s->replace_blocker,
 948                    "block device is in use by block-job-complete");
 949         bdrv_op_block_all(s->to_replace, s->replace_blocker);
 950         bdrv_ref(s->to_replace);
 951
 952         aio_context_release(replace_aio_context);
 953     }
 954
 955     s->should_complete = true;
 956     block_job_enter(&s->common);
 957 }
 958
 959 static void mirror_pause(BlockJob *job)
 960 {
 961     MirrorBlockJob *s = container_of(job, MirrorBlockJob, common);
 962
 963     mirror_wait_for_all_io(s);
 964 }
 965
 966 static void mirror_attached_aio_context(BlockJob *job, AioContext *new_context)
 967 {
 968     MirrorBlockJob *s = container_of(job, MirrorBlockJob, common);
 969
 970     blk_set_aio_context(s->target, new_context);
 971 }
 972
 973 static void mirror_drain(BlockJob *job)
 974 {
 975     MirrorBlockJob *s = container_of(job, MirrorBlockJob, common);
 976
 977     /* Need to keep a reference in case blk_drain triggers execution
 978      * of mirror_complete...
 979      */
 980     if (s->target) {
 981         BlockBackend *target = s->target;
 982         blk_ref(target);
 983         blk_drain(target);
 984         blk_unref(target);
 985     }
 986 }
 987
 988 static const BlockJobDriver mirror_job_driver = {
 989     .job_driver = {
 990         .instance_size          = sizeof(MirrorBlockJob),
 991     },
 992     .job_type               = JOB_TYPE_MIRROR,
 993     .start                  = mirror_run,
 994     .complete               = mirror_complete,
 995     .pause                  = mirror_pause,
 996     .attached_aio_context   = mirror_attached_aio_context,
 997     .drain                  = mirror_drain,
 998 };
 999
1000 static const BlockJobDriver commit_active_job_driver = {
1001     .job_driver = {
1002         .instance_size          = sizeof(MirrorBlockJob),
1003     },
1004     .job_type               = JOB_TYPE_COMMIT,
1005     .start                  = mirror_run,
1006     .complete               = mirror_complete,
1007     .pause                  = mirror_pause,
1008     .attached_aio_context   = mirror_attached_aio_context,
1009     .drain                  = mirror_drain,
1010 };
1011
1012 static int coroutine_fn bdrv_mirror_top_preadv(BlockDriverState *bs,
1013     uint64_t offset, uint64_t bytes, QEMUIOVector *qiov, int flags)
1014 {
1015     return bdrv_co_preadv(bs->backing, offset, bytes, qiov, flags);
1016 }
1017
1018 static int coroutine_fn bdrv_mirror_top_pwritev(BlockDriverState *bs,
1019     uint64_t offset, uint64_t bytes, QEMUIOVector *qiov, int flags)
1020 {
1021     return bdrv_co_pwritev(bs->backing, offset, bytes, qiov, flags);
1022 }
1023
1024 static int coroutine_fn bdrv_mirror_top_flush(BlockDriverState *bs)
1025 {
1026     if (bs->backing == NULL) {
1027         /* we can be here after failed bdrv_append in mirror_start_job */
1028         return 0;
1029     }
1030     return bdrv_co_flush(bs->backing->bs);
1031 }
1032
1033 static int coroutine_fn bdrv_mirror_top_pwrite_zeroes(BlockDriverState *bs,
1034     int64_t offset, int bytes, BdrvRequestFlags flags)
1035 {
1036     return bdrv_co_pwrite_zeroes(bs->backing, offset, bytes, flags);
1037 }
1038
1039 static int coroutine_fn bdrv_mirror_top_pdiscard(BlockDriverState *bs,
1040     int64_t offset, int bytes)
1041 {
1042     return bdrv_co_pdiscard(bs->backing->bs, offset, bytes);
1043 }
1044
1045 static void bdrv_mirror_top_refresh_filename(BlockDriverState *bs, QDict *opts)
1046 {
1047     if (bs->backing == NULL) {
1048         /* we can be here after failed bdrv_attach_child in
1049          * bdrv_set_backing_hd */
1050         return;
1051     }
1052     bdrv_refresh_filename(bs->backing->bs);
1053     pstrcpy(bs->exact_filename, sizeof(bs->exact_filename),
1054             bs->backing->bs->filename);
1055 }
1056
1057 static void bdrv_mirror_top_close(BlockDriverState *bs)
1058 {
1059 }
1060
1061 static void bdrv_mirror_top_child_perm(BlockDriverState *bs, BdrvChild *c,
1062                                        const BdrvChildRole *role,
1063                                        BlockReopenQueue *reopen_queue,
1064                                        uint64_t perm, uint64_t shared,
1065                                        uint64_t *nperm, uint64_t *nshared)
1066 {
1067     /* Must be able to forward guest writes to the real image */
1068     *nperm = 0;
1069     if (perm & BLK_PERM_WRITE) {
1070         *nperm |= BLK_PERM_WRITE;
1071     }
1072
1073     *nshared = BLK_PERM_ALL;
1074 }
1075
1076 /* Dummy node that provides consistent read to its users without requiring it
1077  * from its backing file and that allows writes on the backing file chain. */
1078 static BlockDriver bdrv_mirror_top = {
1079     .format_name                = "mirror_top",
1080     .bdrv_co_preadv             = bdrv_mirror_top_preadv,
1081     .bdrv_co_pwritev            = bdrv_mirror_top_pwritev,
1082     .bdrv_co_pwrite_zeroes      = bdrv_mirror_top_pwrite_zeroes,
1083     .bdrv_co_pdiscard           = bdrv_mirror_top_pdiscard,
1084     .bdrv_co_flush              = bdrv_mirror_top_flush,
1085     .bdrv_co_block_status       = bdrv_co_block_status_from_backing,
1086     .bdrv_refresh_filename      = bdrv_mirror_top_refresh_filename,
1087     .bdrv_close                 = bdrv_mirror_top_close,
1088     .bdrv_child_perm            = bdrv_mirror_top_child_perm,
1089 };
1090
1091 static void mirror_start_job(const char *job_id, BlockDriverState *bs,
1092                              int creation_flags, BlockDriverState *target,
1093                              const char *replaces, int64_t speed,
1094                              uint32_t granularity, int64_t buf_size,
1095                              BlockMirrorBackingMode backing_mode,
1096                              BlockdevOnError on_source_error,
1097                              BlockdevOnError on_target_error,
1098                              bool unmap,
1099                              BlockCompletionFunc *cb,
1100                              void *opaque,
1101                              const BlockJobDriver *driver,
1102                              bool is_none_mode, BlockDriverState *base,
1103                              bool auto_complete, const char *filter_node_name,
1104                              bool is_mirror,
1105                              Error **errp)
1106 {
1107     MirrorBlockJob *s;
1108     BlockDriverState *mirror_top_bs;
1109     bool target_graph_mod;
1110     bool target_is_backing;
1111     Error *local_err = NULL;
1112     int ret;
1113
1114     if (granularity == 0) {
1115         granularity = bdrv_get_default_bitmap_granularity(target);
1116     }
1117
1118     assert(is_power_of_2(granularity));
1119
1120     if (buf_size < 0) {
1121         error_setg(errp, "Invalid parameter 'buf-size'");
1122         return;
1123     }
1124
1125     if (buf_size == 0) {
1126         buf_size = DEFAULT_MIRROR_BUF_SIZE;
1127     }
1128
1129     /* In the case of active commit, add dummy driver to provide consistent
1130      * reads on the top, while disabling it in the intermediate nodes, and make
1131      * the backing chain writable. */
1132     mirror_top_bs = bdrv_new_open_driver(&bdrv_mirror_top, filter_node_name,
1133                                          BDRV_O_RDWR, errp);
1134     if (mirror_top_bs == NULL) {
1135         return;
1136     }
1137     if (!filter_node_name) {
1138         mirror_top_bs->implicit = true;
1139     }
1140     mirror_top_bs->total_sectors = bs->total_sectors;
1141     mirror_top_bs->supported_write_flags = BDRV_REQ_WRITE_UNCHANGED;
1142     mirror_top_bs->supported_zero_flags = BDRV_REQ_WRITE_UNCHANGED;
1143     bdrv_set_aio_context(mirror_top_bs, bdrv_get_aio_context(bs));
1144
1145     /* bdrv_append takes ownership of the mirror_top_bs reference, need to keep
1146      * it alive until block_job_create() succeeds even if bs has no parent. */
1147     bdrv_ref(mirror_top_bs);
1148     bdrv_drained_begin(bs);
1149     bdrv_append(mirror_top_bs, bs, &local_err);
1150     bdrv_drained_end(bs);
1151
1152     if (local_err) {
1153         bdrv_unref(mirror_top_bs);
1154         error_propagate(errp, local_err);
1155         return;
1156     }
1157
1158     /* Make sure that the source is not resized while the job is running */
1159     s = block_job_create(job_id, driver, NULL, mirror_top_bs,
1160                          BLK_PERM_CONSISTENT_READ,
1161                          BLK_PERM_CONSISTENT_READ | BLK_PERM_WRITE_UNCHANGED |
1162                          BLK_PERM_WRITE | BLK_PERM_GRAPH_MOD, speed,
1163                          creation_flags, cb, opaque, errp);
1164     if (!s) {
1165         goto fail;
1166     }
1167     /* The block job now has a reference to this node */
1168     bdrv_unref(mirror_top_bs);
1169
1170     s->source = bs;
1171     s->mirror_top_bs = mirror_top_bs;
1172
1173     /* No resize for the target either; while the mirror is still running, a
1174      * consistent read isn't necessarily possible. We could possibly allow
1175      * writes and graph modifications, though it would likely defeat the
1176      * purpose of a mirror, so leave them blocked for now.
1177      *
1178      * In the case of active commit, things look a bit different, though,
1179      * because the target is an already populated backing file in active use.
1180      * We can allow anything except resize there.*/
1181     target_is_backing = bdrv_chain_contains(bs, target);
1182     target_graph_mod = (backing_mode != MIRROR_LEAVE_BACKING_CHAIN);
1183     s->target = blk_new(BLK_PERM_WRITE | BLK_PERM_RESIZE |
1184                         (target_graph_mod ? BLK_PERM_GRAPH_MOD : 0),
1185                         BLK_PERM_WRITE_UNCHANGED |
1186                         (target_is_backing ? BLK_PERM_CONSISTENT_READ |
1187                                              BLK_PERM_WRITE |
1188                                              BLK_PERM_GRAPH_MOD : 0));
1189     ret = blk_insert_bs(s->target, target, errp);
1190     if (ret < 0) {
1191         goto fail;
1192     }
1193     if (is_mirror) {
1194         /* XXX: Mirror target could be a NBD server of target QEMU in the case
1195          * of non-shared block migration. To allow migration completion, we
1196          * have to allow "inactivate" of the target BB.  When that happens, we
1197          * know the job is drained, and the vcpus are stopped, so no write
1198          * operation will be performed. Block layer already has assertions to
1199          * ensure that. */
1200         blk_set_force_allow_inactivate(s->target);
1201     }
1202
1203     s->replaces = g_strdup(replaces);
1204     s->on_source_error = on_source_error;
1205     s->on_target_error = on_target_error;
1206     s->is_none_mode = is_none_mode;
1207     s->backing_mode = backing_mode;
1208     s->base = base;
1209     s->granularity = granularity;
1210     s->buf_size = ROUND_UP(buf_size, granularity);
1211     s->unmap = unmap;
1212     if (auto_complete) {
1213         s->should_complete = true;
1214     }
1215
1216     s->dirty_bitmap = bdrv_create_dirty_bitmap(bs, granularity, NULL, errp);
1217     if (!s->dirty_bitmap) {
1218         goto fail;
1219     }
1220
1221     /* Required permissions are already taken with blk_new() */
1222     block_job_add_bdrv(&s->common, "target", target, 0, BLK_PERM_ALL,
1223                        &error_abort);
1224
1225     /* In commit_active_start() all intermediate nodes disappear, so
1226      * any jobs in them must be blocked */
1227     if (target_is_backing) {
1228         BlockDriverState *iter;
1229         for (iter = backing_bs(bs); iter != target; iter = backing_bs(iter)) {
1230             /* XXX BLK_PERM_WRITE needs to be allowed so we don't block
1231              * ourselves at s->base (if writes are blocked for a node, they are
1232              * also blocked for its backing file). The other options would be a
1233              * second filter driver above s->base (== target). */
1234             ret = block_job_add_bdrv(&s->common, "intermediate node", iter, 0,
1235                                      BLK_PERM_WRITE_UNCHANGED | BLK_PERM_WRITE,
1236                                      errp);
1237             if (ret < 0) {
1238                 goto fail;
1239             }
1240         }
1241     }
1242
1243     trace_mirror_start(bs, s, opaque);
1244     block_job_start(&s->common);
1245     return;
1246
1247 fail:
1248     if (s) {
1249         /* Make sure this BDS does not go away until we have completed the graph
1250          * changes below */
1251         bdrv_ref(mirror_top_bs);
1252
1253         g_free(s->replaces);
1254         blk_unref(s->target);
1255         block_job_early_fail(&s->common);
1256     }
1257
1258     bdrv_child_try_set_perm(mirror_top_bs->backing, 0, BLK_PERM_ALL,
1259                             &error_abort);
1260     bdrv_replace_node(mirror_top_bs, backing_bs(mirror_top_bs), &error_abort);
1261
1262     bdrv_unref(mirror_top_bs);
1263 }
1264
1265 void mirror_start(const char *job_id, BlockDriverState *bs,
1266                   BlockDriverState *target, const char *replaces,
1267                   int64_t speed, uint32_t granularity, int64_t buf_size,
1268                   MirrorSyncMode mode, BlockMirrorBackingMode backing_mode,
1269                   BlockdevOnError on_source_error,
1270                   BlockdevOnError on_target_error,
1271                   bool unmap, const char *filter_node_name, Error **errp)
1272 {
1273     bool is_none_mode;
1274     BlockDriverState *base;
1275
1276     if (mode == MIRROR_SYNC_MODE_INCREMENTAL) {
1277         error_setg(errp, "Sync mode 'incremental' not supported");
1278         return;
1279     }
1280     is_none_mode = mode == MIRROR_SYNC_MODE_NONE;
1281     base = mode == MIRROR_SYNC_MODE_TOP ? backing_bs(bs) : NULL;
1282     mirror_start_job(job_id, bs, BLOCK_JOB_DEFAULT, target, replaces,
1283                      speed, granularity, buf_size, backing_mode,
1284                      on_source_error, on_target_error, unmap, NULL, NULL,
1285                      &mirror_job_driver, is_none_mode, base, false,
1286                      filter_node_name, true, errp);
1287 }
1288
1289 void commit_active_start(const char *job_id, BlockDriverState *bs,
1290                          BlockDriverState *base, int creation_flags,
1291                          int64_t speed, BlockdevOnError on_error,
1292                          const char *filter_node_name,
1293                          BlockCompletionFunc *cb, void *opaque,
1294                          bool auto_complete, Error **errp)
1295 {
1296     int orig_base_flags;
1297     Error *local_err = NULL;
1298
1299     orig_base_flags = bdrv_get_flags(base);
1300
1301     if (bdrv_reopen(base, bs->open_flags, errp)) {
1302         return;
1303     }
1304
1305     mirror_start_job(job_id, bs, creation_flags, base, NULL, speed, 0, 0,
1306                      MIRROR_LEAVE_BACKING_CHAIN,
1307                      on_error, on_error, true, cb, opaque,
1308                      &commit_active_job_driver, false, base, auto_complete,
1309                      filter_node_name, false, &local_err);
1310     if (local_err) {
1311         error_propagate(errp, local_err);
1312         goto error_restore_flags;
1313     }
1314
1315     return;
1316
1317 error_restore_flags:
1318     /* ignore error and errp for bdrv_reopen, because we want to propagate
1319      * the original error */
1320     bdrv_reopen(base, orig_base_flags, NULL);
1321     return;
1322 }