xref: /openbmc/qemu/block/mirror.c (revision a1857ad1)
1 /*
2  * Image mirroring
3  *
4  * Copyright Red Hat, Inc. 2012
5  *
6  * Authors:
7  *  Paolo Bonzini  <pbonzini@redhat.com>
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 "trace.h"
15 #include "block/blockjob.h"
16 #include "block/block_int.h"
17 #include "qemu/ratelimit.h"
18 #include "qemu/bitmap.h"
19 
20 #define SLICE_TIME    100000000ULL /* ns */
21 #define MAX_IN_FLIGHT 16
22 
23 /* The mirroring buffer is a list of granularity-sized chunks.
24  * Free chunks are organized in a list.
25  */
26 typedef struct MirrorBuffer {
27     QSIMPLEQ_ENTRY(MirrorBuffer) next;
28 } MirrorBuffer;
29 
30 typedef struct MirrorBlockJob {
31     BlockJob common;
32     RateLimit limit;
33     BlockDriverState *target;
34     BlockDriverState *base;
35     /* The name of the graph node to replace */
36     char *replaces;
37     /* The BDS to replace */
38     BlockDriverState *to_replace;
39     /* Used to block operations on the drive-mirror-replace target */
40     Error *replace_blocker;
41     bool is_none_mode;
42     BlockdevOnError on_source_error, on_target_error;
43     bool synced;
44     bool should_complete;
45     int64_t sector_num;
46     int64_t granularity;
47     size_t buf_size;
48     unsigned long *cow_bitmap;
49     BdrvDirtyBitmap *dirty_bitmap;
50     HBitmapIter hbi;
51     uint8_t *buf;
52     QSIMPLEQ_HEAD(, MirrorBuffer) buf_free;
53     int buf_free_count;
54 
55     unsigned long *in_flight_bitmap;
56     int in_flight;
57     int ret;
58 } MirrorBlockJob;
59 
60 typedef struct MirrorOp {
61     MirrorBlockJob *s;
62     QEMUIOVector qiov;
63     int64_t sector_num;
64     int nb_sectors;
65 } MirrorOp;
66 
67 static BlockErrorAction mirror_error_action(MirrorBlockJob *s, bool read,
68                                             int error)
69 {
70     s->synced = false;
71     if (read) {
72         return block_job_error_action(&s->common, s->common.bs,
73                                       s->on_source_error, true, error);
74     } else {
75         return block_job_error_action(&s->common, s->target,
76                                       s->on_target_error, false, error);
77     }
78 }
79 
80 static void mirror_iteration_done(MirrorOp *op, int ret)
81 {
82     MirrorBlockJob *s = op->s;
83     struct iovec *iov;
84     int64_t chunk_num;
85     int i, nb_chunks, sectors_per_chunk;
86 
87     trace_mirror_iteration_done(s, op->sector_num, op->nb_sectors, ret);
88 
89     s->in_flight--;
90     iov = op->qiov.iov;
91     for (i = 0; i < op->qiov.niov; i++) {
92         MirrorBuffer *buf = (MirrorBuffer *) iov[i].iov_base;
93         QSIMPLEQ_INSERT_TAIL(&s->buf_free, buf, next);
94         s->buf_free_count++;
95     }
96 
97     sectors_per_chunk = s->granularity >> BDRV_SECTOR_BITS;
98     chunk_num = op->sector_num / sectors_per_chunk;
99     nb_chunks = op->nb_sectors / sectors_per_chunk;
100     bitmap_clear(s->in_flight_bitmap, chunk_num, nb_chunks);
101     if (s->cow_bitmap && ret >= 0) {
102         bitmap_set(s->cow_bitmap, chunk_num, nb_chunks);
103     }
104 
105     qemu_iovec_destroy(&op->qiov);
106     g_slice_free(MirrorOp, op);
107 
108     /* Enter coroutine when it is not sleeping.  The coroutine sleeps to
109      * rate-limit itself.  The coroutine will eventually resume since there is
110      * a sleep timeout so don't wake it early.
111      */
112     if (s->common.busy) {
113         qemu_coroutine_enter(s->common.co, NULL);
114     }
115 }
116 
117 static void mirror_write_complete(void *opaque, int ret)
118 {
119     MirrorOp *op = opaque;
120     MirrorBlockJob *s = op->s;
121     if (ret < 0) {
122         BlockDriverState *source = s->common.bs;
123         BlockErrorAction action;
124 
125         bdrv_set_dirty(source, op->sector_num, op->nb_sectors);
126         action = mirror_error_action(s, false, -ret);
127         if (action == BLOCK_ERROR_ACTION_REPORT && s->ret >= 0) {
128             s->ret = ret;
129         }
130     }
131     mirror_iteration_done(op, ret);
132 }
133 
134 static void mirror_read_complete(void *opaque, int ret)
135 {
136     MirrorOp *op = opaque;
137     MirrorBlockJob *s = op->s;
138     if (ret < 0) {
139         BlockDriverState *source = s->common.bs;
140         BlockErrorAction action;
141 
142         bdrv_set_dirty(source, op->sector_num, op->nb_sectors);
143         action = mirror_error_action(s, true, -ret);
144         if (action == BLOCK_ERROR_ACTION_REPORT && s->ret >= 0) {
145             s->ret = ret;
146         }
147 
148         mirror_iteration_done(op, ret);
149         return;
150     }
151     bdrv_aio_writev(s->target, op->sector_num, &op->qiov, op->nb_sectors,
152                     mirror_write_complete, op);
153 }
154 
155 static uint64_t coroutine_fn mirror_iteration(MirrorBlockJob *s)
156 {
157     BlockDriverState *source = s->common.bs;
158     int nb_sectors, sectors_per_chunk, nb_chunks;
159     int64_t end, sector_num, next_chunk, next_sector, hbitmap_next_sector;
160     uint64_t delay_ns;
161     MirrorOp *op;
162 
163     s->sector_num = hbitmap_iter_next(&s->hbi);
164     if (s->sector_num < 0) {
165         bdrv_dirty_iter_init(source, s->dirty_bitmap, &s->hbi);
166         s->sector_num = hbitmap_iter_next(&s->hbi);
167         trace_mirror_restart_iter(s,
168                                   bdrv_get_dirty_count(source, s->dirty_bitmap));
169         assert(s->sector_num >= 0);
170     }
171 
172     hbitmap_next_sector = s->sector_num;
173     sector_num = s->sector_num;
174     sectors_per_chunk = s->granularity >> BDRV_SECTOR_BITS;
175     end = s->common.len >> BDRV_SECTOR_BITS;
176 
177     /* Extend the QEMUIOVector to include all adjacent blocks that will
178      * be copied in this operation.
179      *
180      * We have to do this if we have no backing file yet in the destination,
181      * and the cluster size is very large.  Then we need to do COW ourselves.
182      * The first time a cluster is copied, copy it entirely.  Note that,
183      * because both the granularity and the cluster size are powers of two,
184      * the number of sectors to copy cannot exceed one cluster.
185      *
186      * We also want to extend the QEMUIOVector to include more adjacent
187      * dirty blocks if possible, to limit the number of I/O operations and
188      * run efficiently even with a small granularity.
189      */
190     nb_chunks = 0;
191     nb_sectors = 0;
192     next_sector = sector_num;
193     next_chunk = sector_num / sectors_per_chunk;
194 
195     /* Wait for I/O to this cluster (from a previous iteration) to be done.  */
196     while (test_bit(next_chunk, s->in_flight_bitmap)) {
197         trace_mirror_yield_in_flight(s, sector_num, s->in_flight);
198         qemu_coroutine_yield();
199     }
200 
201     do {
202         int added_sectors, added_chunks;
203 
204         if (!bdrv_get_dirty(source, s->dirty_bitmap, next_sector) ||
205             test_bit(next_chunk, s->in_flight_bitmap)) {
206             assert(nb_sectors > 0);
207             break;
208         }
209 
210         added_sectors = sectors_per_chunk;
211         if (s->cow_bitmap && !test_bit(next_chunk, s->cow_bitmap)) {
212             bdrv_round_to_clusters(s->target,
213                                    next_sector, added_sectors,
214                                    &next_sector, &added_sectors);
215 
216             /* On the first iteration, the rounding may make us copy
217              * sectors before the first dirty one.
218              */
219             if (next_sector < sector_num) {
220                 assert(nb_sectors == 0);
221                 sector_num = next_sector;
222                 next_chunk = next_sector / sectors_per_chunk;
223             }
224         }
225 
226         added_sectors = MIN(added_sectors, end - (sector_num + nb_sectors));
227         added_chunks = (added_sectors + sectors_per_chunk - 1) / sectors_per_chunk;
228 
229         /* When doing COW, it may happen that there is not enough space for
230          * a full cluster.  Wait if that is the case.
231          */
232         while (nb_chunks == 0 && s->buf_free_count < added_chunks) {
233             trace_mirror_yield_buf_busy(s, nb_chunks, s->in_flight);
234             qemu_coroutine_yield();
235         }
236         if (s->buf_free_count < nb_chunks + added_chunks) {
237             trace_mirror_break_buf_busy(s, nb_chunks, s->in_flight);
238             break;
239         }
240 
241         /* We have enough free space to copy these sectors.  */
242         bitmap_set(s->in_flight_bitmap, next_chunk, added_chunks);
243 
244         nb_sectors += added_sectors;
245         nb_chunks += added_chunks;
246         next_sector += added_sectors;
247         next_chunk += added_chunks;
248         if (!s->synced && s->common.speed) {
249             delay_ns = ratelimit_calculate_delay(&s->limit, added_sectors);
250         } else {
251             delay_ns = 0;
252         }
253     } while (delay_ns == 0 && next_sector < end);
254 
255     /* Allocate a MirrorOp that is used as an AIO callback.  */
256     op = g_slice_new(MirrorOp);
257     op->s = s;
258     op->sector_num = sector_num;
259     op->nb_sectors = nb_sectors;
260 
261     /* Now make a QEMUIOVector taking enough granularity-sized chunks
262      * from s->buf_free.
263      */
264     qemu_iovec_init(&op->qiov, nb_chunks);
265     next_sector = sector_num;
266     while (nb_chunks-- > 0) {
267         MirrorBuffer *buf = QSIMPLEQ_FIRST(&s->buf_free);
268         size_t remaining = (nb_sectors * BDRV_SECTOR_SIZE) - op->qiov.size;
269 
270         QSIMPLEQ_REMOVE_HEAD(&s->buf_free, next);
271         s->buf_free_count--;
272         qemu_iovec_add(&op->qiov, buf, MIN(s->granularity, remaining));
273 
274         /* Advance the HBitmapIter in parallel, so that we do not examine
275          * the same sector twice.
276          */
277         if (next_sector > hbitmap_next_sector
278             && bdrv_get_dirty(source, s->dirty_bitmap, next_sector)) {
279             hbitmap_next_sector = hbitmap_iter_next(&s->hbi);
280         }
281 
282         next_sector += sectors_per_chunk;
283     }
284 
285     bdrv_reset_dirty(source, sector_num, nb_sectors);
286 
287     /* Copy the dirty cluster.  */
288     s->in_flight++;
289     trace_mirror_one_iteration(s, sector_num, nb_sectors);
290     bdrv_aio_readv(source, sector_num, &op->qiov, nb_sectors,
291                    mirror_read_complete, op);
292     return delay_ns;
293 }
294 
295 static void mirror_free_init(MirrorBlockJob *s)
296 {
297     int granularity = s->granularity;
298     size_t buf_size = s->buf_size;
299     uint8_t *buf = s->buf;
300 
301     assert(s->buf_free_count == 0);
302     QSIMPLEQ_INIT(&s->buf_free);
303     while (buf_size != 0) {
304         MirrorBuffer *cur = (MirrorBuffer *)buf;
305         QSIMPLEQ_INSERT_TAIL(&s->buf_free, cur, next);
306         s->buf_free_count++;
307         buf_size -= granularity;
308         buf += granularity;
309     }
310 }
311 
312 static void mirror_drain(MirrorBlockJob *s)
313 {
314     while (s->in_flight > 0) {
315         qemu_coroutine_yield();
316     }
317 }
318 
319 static void coroutine_fn mirror_run(void *opaque)
320 {
321     MirrorBlockJob *s = opaque;
322     BlockDriverState *bs = s->common.bs;
323     int64_t sector_num, end, sectors_per_chunk, length;
324     uint64_t last_pause_ns;
325     BlockDriverInfo bdi;
326     char backing_filename[1024];
327     int ret = 0;
328     int n;
329 
330     if (block_job_is_cancelled(&s->common)) {
331         goto immediate_exit;
332     }
333 
334     s->common.len = bdrv_getlength(bs);
335     if (s->common.len < 0) {
336         ret = s->common.len;
337         goto immediate_exit;
338     } else if (s->common.len == 0) {
339         /* Report BLOCK_JOB_READY and wait for complete. */
340         block_job_event_ready(&s->common);
341         s->synced = true;
342         while (!block_job_is_cancelled(&s->common) && !s->should_complete) {
343             block_job_yield(&s->common);
344         }
345         s->common.cancelled = false;
346         goto immediate_exit;
347     }
348 
349     length = DIV_ROUND_UP(s->common.len, s->granularity);
350     s->in_flight_bitmap = bitmap_new(length);
351 
352     /* If we have no backing file yet in the destination, we cannot let
353      * the destination do COW.  Instead, we copy sectors around the
354      * dirty data if needed.  We need a bitmap to do that.
355      */
356     bdrv_get_backing_filename(s->target, backing_filename,
357                               sizeof(backing_filename));
358     if (backing_filename[0] && !s->target->backing_hd) {
359         ret = bdrv_get_info(s->target, &bdi);
360         if (ret < 0) {
361             goto immediate_exit;
362         }
363         if (s->granularity < bdi.cluster_size) {
364             s->buf_size = MAX(s->buf_size, bdi.cluster_size);
365             s->cow_bitmap = bitmap_new(length);
366         }
367     }
368 
369     end = s->common.len >> BDRV_SECTOR_BITS;
370     s->buf = qemu_try_blockalign(bs, s->buf_size);
371     if (s->buf == NULL) {
372         ret = -ENOMEM;
373         goto immediate_exit;
374     }
375 
376     sectors_per_chunk = s->granularity >> BDRV_SECTOR_BITS;
377     mirror_free_init(s);
378 
379     if (!s->is_none_mode) {
380         /* First part, loop on the sectors and initialize the dirty bitmap.  */
381         BlockDriverState *base = s->base;
382         for (sector_num = 0; sector_num < end; ) {
383             int64_t next = (sector_num | (sectors_per_chunk - 1)) + 1;
384             ret = bdrv_is_allocated_above(bs, base,
385                                           sector_num, next - sector_num, &n);
386 
387             if (ret < 0) {
388                 goto immediate_exit;
389             }
390 
391             assert(n > 0);
392             if (ret == 1) {
393                 bdrv_set_dirty(bs, sector_num, n);
394                 sector_num = next;
395             } else {
396                 sector_num += n;
397             }
398         }
399     }
400 
401     bdrv_dirty_iter_init(bs, s->dirty_bitmap, &s->hbi);
402     last_pause_ns = qemu_clock_get_ns(QEMU_CLOCK_REALTIME);
403     for (;;) {
404         uint64_t delay_ns = 0;
405         int64_t cnt;
406         bool should_complete;
407 
408         if (s->ret < 0) {
409             ret = s->ret;
410             goto immediate_exit;
411         }
412 
413         cnt = bdrv_get_dirty_count(bs, s->dirty_bitmap);
414 
415         /* Note that even when no rate limit is applied we need to yield
416          * periodically with no pending I/O so that qemu_aio_flush() returns.
417          * We do so every SLICE_TIME nanoseconds, or when there is an error,
418          * or when the source is clean, whichever comes first.
419          */
420         if (qemu_clock_get_ns(QEMU_CLOCK_REALTIME) - last_pause_ns < SLICE_TIME &&
421             s->common.iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
422             if (s->in_flight == MAX_IN_FLIGHT || s->buf_free_count == 0 ||
423                 (cnt == 0 && s->in_flight > 0)) {
424                 trace_mirror_yield(s, s->in_flight, s->buf_free_count, cnt);
425                 qemu_coroutine_yield();
426                 continue;
427             } else if (cnt != 0) {
428                 delay_ns = mirror_iteration(s);
429                 if (delay_ns == 0) {
430                     continue;
431                 }
432             }
433         }
434 
435         should_complete = false;
436         if (s->in_flight == 0 && cnt == 0) {
437             trace_mirror_before_flush(s);
438             ret = bdrv_flush(s->target);
439             if (ret < 0) {
440                 if (mirror_error_action(s, false, -ret) ==
441                     BLOCK_ERROR_ACTION_REPORT) {
442                     goto immediate_exit;
443                 }
444             } else {
445                 /* We're out of the streaming phase.  From now on, if the job
446                  * is cancelled we will actually complete all pending I/O and
447                  * report completion.  This way, block-job-cancel will leave
448                  * the target in a consistent state.
449                  */
450                 s->common.offset = end * BDRV_SECTOR_SIZE;
451                 if (!s->synced) {
452                     block_job_event_ready(&s->common);
453                     s->synced = true;
454                 }
455 
456                 should_complete = s->should_complete ||
457                     block_job_is_cancelled(&s->common);
458                 cnt = bdrv_get_dirty_count(bs, s->dirty_bitmap);
459             }
460         }
461 
462         if (cnt == 0 && should_complete) {
463             /* The dirty bitmap is not updated while operations are pending.
464              * If we're about to exit, wait for pending operations before
465              * calling bdrv_get_dirty_count(bs), or we may exit while the
466              * source has dirty data to copy!
467              *
468              * Note that I/O can be submitted by the guest while
469              * mirror_populate runs.
470              */
471             trace_mirror_before_drain(s, cnt);
472             bdrv_drain_all();
473             cnt = bdrv_get_dirty_count(bs, s->dirty_bitmap);
474         }
475 
476         ret = 0;
477         trace_mirror_before_sleep(s, cnt, s->synced, delay_ns);
478         if (!s->synced) {
479             /* Publish progress */
480             s->common.offset = (end - cnt) * BDRV_SECTOR_SIZE;
481             block_job_sleep_ns(&s->common, QEMU_CLOCK_REALTIME, delay_ns);
482             if (block_job_is_cancelled(&s->common)) {
483                 break;
484             }
485         } else if (!should_complete) {
486             delay_ns = (s->in_flight == 0 && cnt == 0 ? SLICE_TIME : 0);
487             block_job_sleep_ns(&s->common, QEMU_CLOCK_REALTIME, delay_ns);
488         } else if (cnt == 0) {
489             /* The two disks are in sync.  Exit and report successful
490              * completion.
491              */
492             assert(QLIST_EMPTY(&bs->tracked_requests));
493             s->common.cancelled = false;
494             break;
495         }
496         last_pause_ns = qemu_clock_get_ns(QEMU_CLOCK_REALTIME);
497     }
498 
499 immediate_exit:
500     if (s->in_flight > 0) {
501         /* We get here only if something went wrong.  Either the job failed,
502          * or it was cancelled prematurely so that we do not guarantee that
503          * the target is a copy of the source.
504          */
505         assert(ret < 0 || (!s->synced && block_job_is_cancelled(&s->common)));
506         mirror_drain(s);
507     }
508 
509     assert(s->in_flight == 0);
510     qemu_vfree(s->buf);
511     g_free(s->cow_bitmap);
512     g_free(s->in_flight_bitmap);
513     bdrv_release_dirty_bitmap(bs, s->dirty_bitmap);
514     bdrv_iostatus_disable(s->target);
515     if (s->should_complete && ret == 0) {
516         BlockDriverState *to_replace = s->common.bs;
517         if (s->to_replace) {
518             to_replace = s->to_replace;
519         }
520         if (bdrv_get_flags(s->target) != bdrv_get_flags(to_replace)) {
521             bdrv_reopen(s->target, bdrv_get_flags(to_replace), NULL);
522         }
523         bdrv_swap(s->target, to_replace);
524         if (s->common.driver->job_type == BLOCK_JOB_TYPE_COMMIT) {
525             /* drop the bs loop chain formed by the swap: break the loop then
526              * trigger the unref from the top one */
527             BlockDriverState *p = s->base->backing_hd;
528             bdrv_set_backing_hd(s->base, NULL);
529             bdrv_unref(p);
530         }
531     }
532     if (s->to_replace) {
533         bdrv_op_unblock_all(s->to_replace, s->replace_blocker);
534         error_free(s->replace_blocker);
535         bdrv_unref(s->to_replace);
536     }
537     g_free(s->replaces);
538     bdrv_unref(s->target);
539     block_job_completed(&s->common, ret);
540 }
541 
542 static void mirror_set_speed(BlockJob *job, int64_t speed, Error **errp)
543 {
544     MirrorBlockJob *s = container_of(job, MirrorBlockJob, common);
545 
546     if (speed < 0) {
547         error_set(errp, QERR_INVALID_PARAMETER, "speed");
548         return;
549     }
550     ratelimit_set_speed(&s->limit, speed / BDRV_SECTOR_SIZE, SLICE_TIME);
551 }
552 
553 static void mirror_iostatus_reset(BlockJob *job)
554 {
555     MirrorBlockJob *s = container_of(job, MirrorBlockJob, common);
556 
557     bdrv_iostatus_reset(s->target);
558 }
559 
560 static void mirror_complete(BlockJob *job, Error **errp)
561 {
562     MirrorBlockJob *s = container_of(job, MirrorBlockJob, common);
563     Error *local_err = NULL;
564     int ret;
565 
566     ret = bdrv_open_backing_file(s->target, NULL, &local_err);
567     if (ret < 0) {
568         error_propagate(errp, local_err);
569         return;
570     }
571     if (!s->synced) {
572         error_set(errp, QERR_BLOCK_JOB_NOT_READY, job->bs->device_name);
573         return;
574     }
575 
576     /* check the target bs is not blocked and block all operations on it */
577     if (s->replaces) {
578         s->to_replace = check_to_replace_node(s->replaces, &local_err);
579         if (!s->to_replace) {
580             error_propagate(errp, local_err);
581             return;
582         }
583 
584         error_setg(&s->replace_blocker,
585                    "block device is in use by block-job-complete");
586         bdrv_op_block_all(s->to_replace, s->replace_blocker);
587         bdrv_ref(s->to_replace);
588     }
589 
590     s->should_complete = true;
591     block_job_resume(job);
592 }
593 
594 static const BlockJobDriver mirror_job_driver = {
595     .instance_size = sizeof(MirrorBlockJob),
596     .job_type      = BLOCK_JOB_TYPE_MIRROR,
597     .set_speed     = mirror_set_speed,
598     .iostatus_reset= mirror_iostatus_reset,
599     .complete      = mirror_complete,
600 };
601 
602 static const BlockJobDriver commit_active_job_driver = {
603     .instance_size = sizeof(MirrorBlockJob),
604     .job_type      = BLOCK_JOB_TYPE_COMMIT,
605     .set_speed     = mirror_set_speed,
606     .iostatus_reset
607                    = mirror_iostatus_reset,
608     .complete      = mirror_complete,
609 };
610 
611 static void mirror_start_job(BlockDriverState *bs, BlockDriverState *target,
612                              const char *replaces,
613                              int64_t speed, int64_t granularity,
614                              int64_t buf_size,
615                              BlockdevOnError on_source_error,
616                              BlockdevOnError on_target_error,
617                              BlockDriverCompletionFunc *cb,
618                              void *opaque, Error **errp,
619                              const BlockJobDriver *driver,
620                              bool is_none_mode, BlockDriverState *base)
621 {
622     MirrorBlockJob *s;
623 
624     if (granularity == 0) {
625         /* Choose the default granularity based on the target file's cluster
626          * size, clamped between 4k and 64k.  */
627         BlockDriverInfo bdi;
628         if (bdrv_get_info(target, &bdi) >= 0 && bdi.cluster_size != 0) {
629             granularity = MAX(4096, bdi.cluster_size);
630             granularity = MIN(65536, granularity);
631         } else {
632             granularity = 65536;
633         }
634     }
635 
636     assert ((granularity & (granularity - 1)) == 0);
637 
638     if ((on_source_error == BLOCKDEV_ON_ERROR_STOP ||
639          on_source_error == BLOCKDEV_ON_ERROR_ENOSPC) &&
640         !bdrv_iostatus_is_enabled(bs)) {
641         error_set(errp, QERR_INVALID_PARAMETER, "on-source-error");
642         return;
643     }
644 
645 
646     s = block_job_create(driver, bs, speed, cb, opaque, errp);
647     if (!s) {
648         return;
649     }
650 
651     s->replaces = g_strdup(replaces);
652     s->on_source_error = on_source_error;
653     s->on_target_error = on_target_error;
654     s->target = target;
655     s->is_none_mode = is_none_mode;
656     s->base = base;
657     s->granularity = granularity;
658     s->buf_size = MAX(buf_size, granularity);
659 
660     s->dirty_bitmap = bdrv_create_dirty_bitmap(bs, granularity, errp);
661     if (!s->dirty_bitmap) {
662         return;
663     }
664     bdrv_set_enable_write_cache(s->target, true);
665     bdrv_set_on_error(s->target, on_target_error, on_target_error);
666     bdrv_iostatus_enable(s->target);
667     s->common.co = qemu_coroutine_create(mirror_run);
668     trace_mirror_start(bs, s, s->common.co, opaque);
669     qemu_coroutine_enter(s->common.co, s);
670 }
671 
672 void mirror_start(BlockDriverState *bs, BlockDriverState *target,
673                   const char *replaces,
674                   int64_t speed, int64_t granularity, int64_t buf_size,
675                   MirrorSyncMode mode, BlockdevOnError on_source_error,
676                   BlockdevOnError on_target_error,
677                   BlockDriverCompletionFunc *cb,
678                   void *opaque, Error **errp)
679 {
680     bool is_none_mode;
681     BlockDriverState *base;
682 
683     is_none_mode = mode == MIRROR_SYNC_MODE_NONE;
684     base = mode == MIRROR_SYNC_MODE_TOP ? bs->backing_hd : NULL;
685     mirror_start_job(bs, target, replaces,
686                      speed, granularity, buf_size,
687                      on_source_error, on_target_error, cb, opaque, errp,
688                      &mirror_job_driver, is_none_mode, base);
689 }
690 
691 void commit_active_start(BlockDriverState *bs, BlockDriverState *base,
692                          int64_t speed,
693                          BlockdevOnError on_error,
694                          BlockDriverCompletionFunc *cb,
695                          void *opaque, Error **errp)
696 {
697     int64_t length, base_length;
698     int orig_base_flags;
699     int ret;
700     Error *local_err = NULL;
701 
702     orig_base_flags = bdrv_get_flags(base);
703 
704     if (bdrv_reopen(base, bs->open_flags, errp)) {
705         return;
706     }
707 
708     length = bdrv_getlength(bs);
709     if (length < 0) {
710         error_setg_errno(errp, -length,
711                          "Unable to determine length of %s", bs->filename);
712         goto error_restore_flags;
713     }
714 
715     base_length = bdrv_getlength(base);
716     if (base_length < 0) {
717         error_setg_errno(errp, -base_length,
718                          "Unable to determine length of %s", base->filename);
719         goto error_restore_flags;
720     }
721 
722     if (length > base_length) {
723         ret = bdrv_truncate(base, length);
724         if (ret < 0) {
725             error_setg_errno(errp, -ret,
726                             "Top image %s is larger than base image %s, and "
727                              "resize of base image failed",
728                              bs->filename, base->filename);
729             goto error_restore_flags;
730         }
731     }
732 
733     bdrv_ref(base);
734     mirror_start_job(bs, base, NULL, speed, 0, 0,
735                      on_error, on_error, cb, opaque, &local_err,
736                      &commit_active_job_driver, false, base);
737     if (local_err) {
738         error_propagate(errp, local_err);
739         goto error_restore_flags;
740     }
741 
742     return;
743 
744 error_restore_flags:
745     /* ignore error and errp for bdrv_reopen, because we want to propagate
746      * the original error */
747     bdrv_reopen(base, orig_base_flags, NULL);
748     return;
749 }
750