4 * Copyright Red Hat, Inc. 2012
7 * Paolo Bonzini <pbonzini@redhat.com>
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.
14 #include "qemu/osdep.h"
16 #include "block/blockjob.h"
17 #include "block/block_int.h"
18 #include "sysemu/block-backend.h"
19 #include "qapi/error.h"
20 #include "qapi/qmp/qerror.h"
21 #include "qemu/ratelimit.h"
22 #include "qemu/bitmap.h"
24 #define SLICE_TIME 100000000ULL /* ns */
25 #define MAX_IN_FLIGHT 16
26 #define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
28 /* The mirroring buffer is a list of granularity-sized chunks.
29 * Free chunks are organized in a list.
31 typedef struct MirrorBuffer
{
32 QSIMPLEQ_ENTRY(MirrorBuffer
) next
;
35 typedef struct MirrorBlockJob
{
39 BlockDriverState
*base
;
40 /* The name of the graph node to replace */
42 /* The BDS to replace */
43 BlockDriverState
*to_replace
;
44 /* Used to block operations on the drive-mirror-replace target */
45 Error
*replace_blocker
;
47 BlockMirrorBackingMode backing_mode
;
48 BlockdevOnError on_source_error
, on_target_error
;
54 unsigned long *cow_bitmap
;
55 BdrvDirtyBitmap
*dirty_bitmap
;
58 QSIMPLEQ_HEAD(, MirrorBuffer
) buf_free
;
61 unsigned long *in_flight_bitmap
;
63 int sectors_in_flight
;
67 int target_cluster_sectors
;
71 typedef struct MirrorOp
{
78 static BlockErrorAction
mirror_error_action(MirrorBlockJob
*s
, bool read
,
83 return block_job_error_action(&s
->common
, s
->on_source_error
,
86 return block_job_error_action(&s
->common
, s
->on_target_error
,
91 static void mirror_iteration_done(MirrorOp
*op
, int ret
)
93 MirrorBlockJob
*s
= op
->s
;
96 int i
, nb_chunks
, sectors_per_chunk
;
98 trace_mirror_iteration_done(s
, op
->sector_num
, op
->nb_sectors
, ret
);
101 s
->sectors_in_flight
-= op
->nb_sectors
;
103 for (i
= 0; i
< op
->qiov
.niov
; i
++) {
104 MirrorBuffer
*buf
= (MirrorBuffer
*) iov
[i
].iov_base
;
105 QSIMPLEQ_INSERT_TAIL(&s
->buf_free
, buf
, next
);
109 sectors_per_chunk
= s
->granularity
>> BDRV_SECTOR_BITS
;
110 chunk_num
= op
->sector_num
/ sectors_per_chunk
;
111 nb_chunks
= DIV_ROUND_UP(op
->nb_sectors
, sectors_per_chunk
);
112 bitmap_clear(s
->in_flight_bitmap
, chunk_num
, nb_chunks
);
115 bitmap_set(s
->cow_bitmap
, chunk_num
, nb_chunks
);
117 s
->common
.offset
+= (uint64_t)op
->nb_sectors
* BDRV_SECTOR_SIZE
;
120 qemu_iovec_destroy(&op
->qiov
);
123 if (s
->waiting_for_io
) {
124 qemu_coroutine_enter(s
->common
.co
);
128 static void mirror_write_complete(void *opaque
, int ret
)
130 MirrorOp
*op
= opaque
;
131 MirrorBlockJob
*s
= op
->s
;
133 BlockErrorAction action
;
135 bdrv_set_dirty_bitmap(s
->dirty_bitmap
, op
->sector_num
, op
->nb_sectors
);
136 action
= mirror_error_action(s
, false, -ret
);
137 if (action
== BLOCK_ERROR_ACTION_REPORT
&& s
->ret
>= 0) {
141 mirror_iteration_done(op
, ret
);
144 static void mirror_read_complete(void *opaque
, int ret
)
146 MirrorOp
*op
= opaque
;
147 MirrorBlockJob
*s
= op
->s
;
149 BlockErrorAction action
;
151 bdrv_set_dirty_bitmap(s
->dirty_bitmap
, op
->sector_num
, op
->nb_sectors
);
152 action
= mirror_error_action(s
, true, -ret
);
153 if (action
== BLOCK_ERROR_ACTION_REPORT
&& s
->ret
>= 0) {
157 mirror_iteration_done(op
, ret
);
160 blk_aio_pwritev(s
->target
, op
->sector_num
* BDRV_SECTOR_SIZE
, &op
->qiov
,
161 0, mirror_write_complete
, op
);
164 static inline void mirror_clip_sectors(MirrorBlockJob
*s
,
168 *nb_sectors
= MIN(*nb_sectors
,
169 s
->bdev_length
/ BDRV_SECTOR_SIZE
- sector_num
);
172 /* Round sector_num and/or nb_sectors to target cluster if COW is needed, and
173 * return the offset of the adjusted tail sector against original. */
174 static int mirror_cow_align(MirrorBlockJob
*s
,
180 int chunk_sectors
= s
->granularity
>> BDRV_SECTOR_BITS
;
181 int64_t align_sector_num
= *sector_num
;
182 int align_nb_sectors
= *nb_sectors
;
183 int max_sectors
= chunk_sectors
* s
->max_iov
;
185 need_cow
= !test_bit(*sector_num
/ chunk_sectors
, s
->cow_bitmap
);
186 need_cow
|= !test_bit((*sector_num
+ *nb_sectors
- 1) / chunk_sectors
,
189 bdrv_round_sectors_to_clusters(blk_bs(s
->target
), *sector_num
,
190 *nb_sectors
, &align_sector_num
,
194 if (align_nb_sectors
> max_sectors
) {
195 align_nb_sectors
= max_sectors
;
197 align_nb_sectors
= QEMU_ALIGN_DOWN(align_nb_sectors
,
198 s
->target_cluster_sectors
);
201 /* Clipping may result in align_nb_sectors unaligned to chunk boundary, but
202 * that doesn't matter because it's already the end of source image. */
203 mirror_clip_sectors(s
, align_sector_num
, &align_nb_sectors
);
205 ret
= align_sector_num
+ align_nb_sectors
- (*sector_num
+ *nb_sectors
);
206 *sector_num
= align_sector_num
;
207 *nb_sectors
= align_nb_sectors
;
212 static inline void mirror_wait_for_io(MirrorBlockJob
*s
)
214 assert(!s
->waiting_for_io
);
215 s
->waiting_for_io
= true;
216 qemu_coroutine_yield();
217 s
->waiting_for_io
= false;
220 /* Submit async read while handling COW.
221 * Returns: The number of sectors copied after and including sector_num,
222 * excluding any sectors copied prior to sector_num due to alignment.
223 * This will be nb_sectors if no alignment is necessary, or
224 * (new_end - sector_num) if tail is rounded up or down due to
225 * alignment or buffer limit.
227 static int mirror_do_read(MirrorBlockJob
*s
, int64_t sector_num
,
230 BlockBackend
*source
= s
->common
.blk
;
231 int sectors_per_chunk
, nb_chunks
;
236 sectors_per_chunk
= s
->granularity
>> BDRV_SECTOR_BITS
;
237 max_sectors
= sectors_per_chunk
* s
->max_iov
;
239 /* We can only handle as much as buf_size at a time. */
240 nb_sectors
= MIN(s
->buf_size
>> BDRV_SECTOR_BITS
, nb_sectors
);
241 nb_sectors
= MIN(max_sectors
, nb_sectors
);
246 ret
+= mirror_cow_align(s
, §or_num
, &nb_sectors
);
248 assert(nb_sectors
<< BDRV_SECTOR_BITS
<= s
->buf_size
);
249 /* The sector range must meet granularity because:
250 * 1) Caller passes in aligned values;
251 * 2) mirror_cow_align is used only when target cluster is larger. */
252 assert(!(sector_num
% sectors_per_chunk
));
253 nb_chunks
= DIV_ROUND_UP(nb_sectors
, sectors_per_chunk
);
255 while (s
->buf_free_count
< nb_chunks
) {
256 trace_mirror_yield_in_flight(s
, sector_num
, s
->in_flight
);
257 mirror_wait_for_io(s
);
260 /* Allocate a MirrorOp that is used as an AIO callback. */
261 op
= g_new(MirrorOp
, 1);
263 op
->sector_num
= sector_num
;
264 op
->nb_sectors
= nb_sectors
;
266 /* Now make a QEMUIOVector taking enough granularity-sized chunks
269 qemu_iovec_init(&op
->qiov
, nb_chunks
);
270 while (nb_chunks
-- > 0) {
271 MirrorBuffer
*buf
= QSIMPLEQ_FIRST(&s
->buf_free
);
272 size_t remaining
= nb_sectors
* BDRV_SECTOR_SIZE
- op
->qiov
.size
;
274 QSIMPLEQ_REMOVE_HEAD(&s
->buf_free
, next
);
276 qemu_iovec_add(&op
->qiov
, buf
, MIN(s
->granularity
, remaining
));
279 /* Copy the dirty cluster. */
281 s
->sectors_in_flight
+= nb_sectors
;
282 trace_mirror_one_iteration(s
, sector_num
, nb_sectors
);
284 blk_aio_preadv(source
, sector_num
* BDRV_SECTOR_SIZE
, &op
->qiov
, 0,
285 mirror_read_complete
, op
);
289 static void mirror_do_zero_or_discard(MirrorBlockJob
*s
,
296 /* Allocate a MirrorOp that is used as an AIO callback. The qiov is zeroed
297 * so the freeing in mirror_iteration_done is nop. */
298 op
= g_new0(MirrorOp
, 1);
300 op
->sector_num
= sector_num
;
301 op
->nb_sectors
= nb_sectors
;
304 s
->sectors_in_flight
+= nb_sectors
;
306 blk_aio_discard(s
->target
, sector_num
, op
->nb_sectors
,
307 mirror_write_complete
, op
);
309 blk_aio_pwrite_zeroes(s
->target
, sector_num
* BDRV_SECTOR_SIZE
,
310 op
->nb_sectors
* BDRV_SECTOR_SIZE
,
311 s
->unmap
? BDRV_REQ_MAY_UNMAP
: 0,
312 mirror_write_complete
, op
);
316 static uint64_t coroutine_fn
mirror_iteration(MirrorBlockJob
*s
)
318 BlockDriverState
*source
= blk_bs(s
->common
.blk
);
319 int64_t sector_num
, first_chunk
;
320 uint64_t delay_ns
= 0;
321 /* At least the first dirty chunk is mirrored in one iteration. */
323 int64_t end
= s
->bdev_length
/ BDRV_SECTOR_SIZE
;
324 int sectors_per_chunk
= s
->granularity
>> BDRV_SECTOR_BITS
;
326 sector_num
= hbitmap_iter_next(&s
->hbi
);
327 if (sector_num
< 0) {
328 bdrv_dirty_iter_init(s
->dirty_bitmap
, &s
->hbi
);
329 sector_num
= hbitmap_iter_next(&s
->hbi
);
330 trace_mirror_restart_iter(s
, bdrv_get_dirty_count(s
->dirty_bitmap
));
331 assert(sector_num
>= 0);
334 first_chunk
= sector_num
/ sectors_per_chunk
;
335 while (test_bit(first_chunk
, s
->in_flight_bitmap
)) {
336 trace_mirror_yield_in_flight(s
, sector_num
, s
->in_flight
);
337 mirror_wait_for_io(s
);
340 block_job_pause_point(&s
->common
);
342 /* Find the number of consective dirty chunks following the first dirty
343 * one, and wait for in flight requests in them. */
344 while (nb_chunks
* sectors_per_chunk
< (s
->buf_size
>> BDRV_SECTOR_BITS
)) {
345 int64_t hbitmap_next
;
346 int64_t next_sector
= sector_num
+ nb_chunks
* sectors_per_chunk
;
347 int64_t next_chunk
= next_sector
/ sectors_per_chunk
;
348 if (next_sector
>= end
||
349 !bdrv_get_dirty(source
, s
->dirty_bitmap
, next_sector
)) {
352 if (test_bit(next_chunk
, s
->in_flight_bitmap
)) {
356 hbitmap_next
= hbitmap_iter_next(&s
->hbi
);
357 if (hbitmap_next
> next_sector
|| hbitmap_next
< 0) {
358 /* The bitmap iterator's cache is stale, refresh it */
359 bdrv_set_dirty_iter(&s
->hbi
, next_sector
);
360 hbitmap_next
= hbitmap_iter_next(&s
->hbi
);
362 assert(hbitmap_next
== next_sector
);
366 /* Clear dirty bits before querying the block status, because
367 * calling bdrv_get_block_status_above could yield - if some blocks are
368 * marked dirty in this window, we need to know.
370 bdrv_reset_dirty_bitmap(s
->dirty_bitmap
, sector_num
,
371 nb_chunks
* sectors_per_chunk
);
372 bitmap_set(s
->in_flight_bitmap
, sector_num
/ sectors_per_chunk
, nb_chunks
);
373 while (nb_chunks
> 0 && sector_num
< end
) {
376 BlockDriverState
*file
;
380 MIRROR_METHOD_DISCARD
381 } mirror_method
= MIRROR_METHOD_COPY
;
383 assert(!(sector_num
% sectors_per_chunk
));
384 ret
= bdrv_get_block_status_above(source
, NULL
, sector_num
,
385 nb_chunks
* sectors_per_chunk
,
388 io_sectors
= nb_chunks
* sectors_per_chunk
;
391 io_sectors
-= io_sectors
% sectors_per_chunk
;
392 if (io_sectors
< sectors_per_chunk
) {
393 io_sectors
= sectors_per_chunk
;
394 } else if (ret
>= 0 && !(ret
& BDRV_BLOCK_DATA
)) {
395 int64_t target_sector_num
;
396 int target_nb_sectors
;
397 bdrv_round_sectors_to_clusters(blk_bs(s
->target
), sector_num
,
398 io_sectors
, &target_sector_num
,
400 if (target_sector_num
== sector_num
&&
401 target_nb_sectors
== io_sectors
) {
402 mirror_method
= ret
& BDRV_BLOCK_ZERO
?
404 MIRROR_METHOD_DISCARD
;
408 mirror_clip_sectors(s
, sector_num
, &io_sectors
);
409 switch (mirror_method
) {
410 case MIRROR_METHOD_COPY
:
411 io_sectors
= mirror_do_read(s
, sector_num
, io_sectors
);
413 case MIRROR_METHOD_ZERO
:
414 mirror_do_zero_or_discard(s
, sector_num
, io_sectors
, false);
416 case MIRROR_METHOD_DISCARD
:
417 mirror_do_zero_or_discard(s
, sector_num
, io_sectors
, true);
423 sector_num
+= io_sectors
;
424 nb_chunks
-= DIV_ROUND_UP(io_sectors
, sectors_per_chunk
);
425 if (s
->common
.speed
) {
426 delay_ns
= ratelimit_calculate_delay(&s
->limit
, io_sectors
);
432 static void mirror_free_init(MirrorBlockJob
*s
)
434 int granularity
= s
->granularity
;
435 size_t buf_size
= s
->buf_size
;
436 uint8_t *buf
= s
->buf
;
438 assert(s
->buf_free_count
== 0);
439 QSIMPLEQ_INIT(&s
->buf_free
);
440 while (buf_size
!= 0) {
441 MirrorBuffer
*cur
= (MirrorBuffer
*)buf
;
442 QSIMPLEQ_INSERT_TAIL(&s
->buf_free
, cur
, next
);
444 buf_size
-= granularity
;
449 static void mirror_drain(MirrorBlockJob
*s
)
451 while (s
->in_flight
> 0) {
452 mirror_wait_for_io(s
);
460 static void mirror_exit(BlockJob
*job
, void *opaque
)
462 MirrorBlockJob
*s
= container_of(job
, MirrorBlockJob
, common
);
463 MirrorExitData
*data
= opaque
;
464 AioContext
*replace_aio_context
= NULL
;
465 BlockDriverState
*src
= blk_bs(s
->common
.blk
);
466 BlockDriverState
*target_bs
= blk_bs(s
->target
);
468 /* Make sure that the source BDS doesn't go away before we called
469 * block_job_completed(). */
473 replace_aio_context
= bdrv_get_aio_context(s
->to_replace
);
474 aio_context_acquire(replace_aio_context
);
477 if (s
->should_complete
&& data
->ret
== 0) {
478 BlockDriverState
*to_replace
= src
;
480 to_replace
= s
->to_replace
;
483 if (bdrv_get_flags(target_bs
) != bdrv_get_flags(to_replace
)) {
484 bdrv_reopen(target_bs
, bdrv_get_flags(to_replace
), NULL
);
487 /* The mirror job has no requests in flight any more, but we need to
488 * drain potential other users of the BDS before changing the graph. */
489 bdrv_drained_begin(target_bs
);
490 bdrv_replace_in_backing_chain(to_replace
, target_bs
);
491 bdrv_drained_end(target_bs
);
493 /* We just changed the BDS the job BB refers to */
494 blk_remove_bs(job
->blk
);
495 blk_insert_bs(job
->blk
, src
);
498 bdrv_op_unblock_all(s
->to_replace
, s
->replace_blocker
);
499 error_free(s
->replace_blocker
);
500 bdrv_unref(s
->to_replace
);
502 if (replace_aio_context
) {
503 aio_context_release(replace_aio_context
);
506 bdrv_op_unblock_all(target_bs
, s
->common
.blocker
);
507 blk_unref(s
->target
);
508 block_job_completed(&s
->common
, data
->ret
);
510 bdrv_drained_end(src
);
514 static void coroutine_fn
mirror_run(void *opaque
)
516 MirrorBlockJob
*s
= opaque
;
517 MirrorExitData
*data
;
518 BlockDriverState
*bs
= blk_bs(s
->common
.blk
);
519 BlockDriverState
*target_bs
= blk_bs(s
->target
);
520 int64_t sector_num
, end
, length
;
521 uint64_t last_pause_ns
;
523 char backing_filename
[2]; /* we only need 2 characters because we are only
524 checking for a NULL string */
527 int target_cluster_size
= BDRV_SECTOR_SIZE
;
529 if (block_job_is_cancelled(&s
->common
)) {
533 s
->bdev_length
= bdrv_getlength(bs
);
534 if (s
->bdev_length
< 0) {
535 ret
= s
->bdev_length
;
537 } else if (s
->bdev_length
== 0) {
538 /* Report BLOCK_JOB_READY and wait for complete. */
539 block_job_event_ready(&s
->common
);
541 while (!block_job_is_cancelled(&s
->common
) && !s
->should_complete
) {
542 block_job_yield(&s
->common
);
544 s
->common
.cancelled
= false;
548 length
= DIV_ROUND_UP(s
->bdev_length
, s
->granularity
);
549 s
->in_flight_bitmap
= bitmap_new(length
);
551 /* If we have no backing file yet in the destination, we cannot let
552 * the destination do COW. Instead, we copy sectors around the
553 * dirty data if needed. We need a bitmap to do that.
555 bdrv_get_backing_filename(target_bs
, backing_filename
,
556 sizeof(backing_filename
));
557 if (!bdrv_get_info(target_bs
, &bdi
) && bdi
.cluster_size
) {
558 target_cluster_size
= bdi
.cluster_size
;
560 if (backing_filename
[0] && !target_bs
->backing
561 && s
->granularity
< target_cluster_size
) {
562 s
->buf_size
= MAX(s
->buf_size
, target_cluster_size
);
563 s
->cow_bitmap
= bitmap_new(length
);
565 s
->target_cluster_sectors
= target_cluster_size
>> BDRV_SECTOR_BITS
;
566 s
->max_iov
= MIN(bs
->bl
.max_iov
, target_bs
->bl
.max_iov
);
568 end
= s
->bdev_length
/ BDRV_SECTOR_SIZE
;
569 s
->buf
= qemu_try_blockalign(bs
, s
->buf_size
);
570 if (s
->buf
== NULL
) {
577 last_pause_ns
= qemu_clock_get_ns(QEMU_CLOCK_REALTIME
);
578 if (!s
->is_none_mode
) {
579 /* First part, loop on the sectors and initialize the dirty bitmap. */
580 BlockDriverState
*base
= s
->base
;
581 bool mark_all_dirty
= s
->base
== NULL
&& !bdrv_has_zero_init(target_bs
);
583 for (sector_num
= 0; sector_num
< end
; ) {
584 /* Just to make sure we are not exceeding int limit. */
585 int nb_sectors
= MIN(INT_MAX
>> BDRV_SECTOR_BITS
,
587 int64_t now
= qemu_clock_get_ns(QEMU_CLOCK_REALTIME
);
589 if (now
- last_pause_ns
> SLICE_TIME
) {
591 block_job_sleep_ns(&s
->common
, QEMU_CLOCK_REALTIME
, 0);
593 block_job_pause_point(&s
->common
);
596 if (block_job_is_cancelled(&s
->common
)) {
600 ret
= bdrv_is_allocated_above(bs
, base
, sector_num
, nb_sectors
, &n
);
607 if (ret
== 1 || mark_all_dirty
) {
608 bdrv_set_dirty_bitmap(s
->dirty_bitmap
, sector_num
, n
);
614 bdrv_dirty_iter_init(s
->dirty_bitmap
, &s
->hbi
);
616 uint64_t delay_ns
= 0;
618 bool should_complete
;
625 block_job_pause_point(&s
->common
);
627 cnt
= bdrv_get_dirty_count(s
->dirty_bitmap
);
628 /* s->common.offset contains the number of bytes already processed so
629 * far, cnt is the number of dirty sectors remaining and
630 * s->sectors_in_flight is the number of sectors currently being
631 * processed; together those are the current total operation length */
632 s
->common
.len
= s
->common
.offset
+
633 (cnt
+ s
->sectors_in_flight
) * BDRV_SECTOR_SIZE
;
635 /* Note that even when no rate limit is applied we need to yield
636 * periodically with no pending I/O so that bdrv_drain_all() returns.
637 * We do so every SLICE_TIME nanoseconds, or when there is an error,
638 * or when the source is clean, whichever comes first.
640 if (qemu_clock_get_ns(QEMU_CLOCK_REALTIME
) - last_pause_ns
< SLICE_TIME
&&
641 s
->common
.iostatus
== BLOCK_DEVICE_IO_STATUS_OK
) {
642 if (s
->in_flight
== MAX_IN_FLIGHT
|| s
->buf_free_count
== 0 ||
643 (cnt
== 0 && s
->in_flight
> 0)) {
644 trace_mirror_yield(s
, s
->in_flight
, s
->buf_free_count
, cnt
);
645 mirror_wait_for_io(s
);
647 } else if (cnt
!= 0) {
648 delay_ns
= mirror_iteration(s
);
652 should_complete
= false;
653 if (s
->in_flight
== 0 && cnt
== 0) {
654 trace_mirror_before_flush(s
);
655 ret
= blk_flush(s
->target
);
657 if (mirror_error_action(s
, false, -ret
) ==
658 BLOCK_ERROR_ACTION_REPORT
) {
662 /* We're out of the streaming phase. From now on, if the job
663 * is cancelled we will actually complete all pending I/O and
664 * report completion. This way, block-job-cancel will leave
665 * the target in a consistent state.
668 block_job_event_ready(&s
->common
);
672 should_complete
= s
->should_complete
||
673 block_job_is_cancelled(&s
->common
);
674 cnt
= bdrv_get_dirty_count(s
->dirty_bitmap
);
678 if (cnt
== 0 && should_complete
) {
679 /* The dirty bitmap is not updated while operations are pending.
680 * If we're about to exit, wait for pending operations before
681 * calling bdrv_get_dirty_count(bs), or we may exit while the
682 * source has dirty data to copy!
684 * Note that I/O can be submitted by the guest while
685 * mirror_populate runs.
687 trace_mirror_before_drain(s
, cnt
);
689 cnt
= bdrv_get_dirty_count(s
->dirty_bitmap
);
693 trace_mirror_before_sleep(s
, cnt
, s
->synced
, delay_ns
);
695 block_job_sleep_ns(&s
->common
, QEMU_CLOCK_REALTIME
, delay_ns
);
696 if (block_job_is_cancelled(&s
->common
)) {
699 } else if (!should_complete
) {
700 delay_ns
= (s
->in_flight
== 0 && cnt
== 0 ? SLICE_TIME
: 0);
701 block_job_sleep_ns(&s
->common
, QEMU_CLOCK_REALTIME
, delay_ns
);
702 } else if (cnt
== 0) {
703 /* The two disks are in sync. Exit and report successful
706 assert(QLIST_EMPTY(&bs
->tracked_requests
));
707 s
->common
.cancelled
= false;
710 last_pause_ns
= qemu_clock_get_ns(QEMU_CLOCK_REALTIME
);
714 if (s
->in_flight
> 0) {
715 /* We get here only if something went wrong. Either the job failed,
716 * or it was cancelled prematurely so that we do not guarantee that
717 * the target is a copy of the source.
719 assert(ret
< 0 || (!s
->synced
&& block_job_is_cancelled(&s
->common
)));
723 assert(s
->in_flight
== 0);
725 g_free(s
->cow_bitmap
);
726 g_free(s
->in_flight_bitmap
);
727 bdrv_release_dirty_bitmap(bs
, s
->dirty_bitmap
);
729 data
= g_malloc(sizeof(*data
));
731 /* Before we switch to target in mirror_exit, make sure data doesn't
733 bdrv_drained_begin(bs
);
734 block_job_defer_to_main_loop(&s
->common
, mirror_exit
, data
);
737 static void mirror_set_speed(BlockJob
*job
, int64_t speed
, Error
**errp
)
739 MirrorBlockJob
*s
= container_of(job
, MirrorBlockJob
, common
);
742 error_setg(errp
, QERR_INVALID_PARAMETER
, "speed");
745 ratelimit_set_speed(&s
->limit
, speed
/ BDRV_SECTOR_SIZE
, SLICE_TIME
);
748 static void mirror_complete(BlockJob
*job
, Error
**errp
)
750 MirrorBlockJob
*s
= container_of(job
, MirrorBlockJob
, common
);
751 BlockDriverState
*src
, *target
;
753 src
= blk_bs(job
->blk
);
754 target
= blk_bs(s
->target
);
757 error_setg(errp
, "The active block job '%s' cannot be completed",
762 if (s
->backing_mode
== MIRROR_OPEN_BACKING_CHAIN
) {
765 assert(!target
->backing
);
766 ret
= bdrv_open_backing_file(target
, NULL
, "backing", errp
);
772 /* block all operations on to_replace bs */
774 AioContext
*replace_aio_context
;
776 s
->to_replace
= bdrv_find_node(s
->replaces
);
777 if (!s
->to_replace
) {
778 error_setg(errp
, "Node name '%s' not found", s
->replaces
);
782 replace_aio_context
= bdrv_get_aio_context(s
->to_replace
);
783 aio_context_acquire(replace_aio_context
);
785 error_setg(&s
->replace_blocker
,
786 "block device is in use by block-job-complete");
787 bdrv_op_block_all(s
->to_replace
, s
->replace_blocker
);
788 bdrv_ref(s
->to_replace
);
790 aio_context_release(replace_aio_context
);
793 if (s
->backing_mode
== MIRROR_SOURCE_BACKING_CHAIN
) {
794 BlockDriverState
*backing
= s
->is_none_mode
? src
: s
->base
;
795 if (backing_bs(target
) != backing
) {
796 bdrv_set_backing_hd(target
, backing
);
800 s
->should_complete
= true;
801 block_job_enter(&s
->common
);
804 /* There is no matching mirror_resume() because mirror_run() will begin
805 * iterating again when the job is resumed.
807 static void coroutine_fn
mirror_pause(BlockJob
*job
)
809 MirrorBlockJob
*s
= container_of(job
, MirrorBlockJob
, common
);
814 static void mirror_attached_aio_context(BlockJob
*job
, AioContext
*new_context
)
816 MirrorBlockJob
*s
= container_of(job
, MirrorBlockJob
, common
);
818 blk_set_aio_context(s
->target
, new_context
);
821 static const BlockJobDriver mirror_job_driver
= {
822 .instance_size
= sizeof(MirrorBlockJob
),
823 .job_type
= BLOCK_JOB_TYPE_MIRROR
,
824 .set_speed
= mirror_set_speed
,
825 .complete
= mirror_complete
,
826 .pause
= mirror_pause
,
827 .attached_aio_context
= mirror_attached_aio_context
,
830 static const BlockJobDriver commit_active_job_driver
= {
831 .instance_size
= sizeof(MirrorBlockJob
),
832 .job_type
= BLOCK_JOB_TYPE_COMMIT
,
833 .set_speed
= mirror_set_speed
,
834 .complete
= mirror_complete
,
835 .pause
= mirror_pause
,
836 .attached_aio_context
= mirror_attached_aio_context
,
839 static void mirror_start_job(const char *job_id
, BlockDriverState
*bs
,
840 BlockDriverState
*target
, const char *replaces
,
841 int64_t speed
, uint32_t granularity
,
843 BlockMirrorBackingMode backing_mode
,
844 BlockdevOnError on_source_error
,
845 BlockdevOnError on_target_error
,
847 BlockCompletionFunc
*cb
,
848 void *opaque
, Error
**errp
,
849 const BlockJobDriver
*driver
,
850 bool is_none_mode
, BlockDriverState
*base
)
854 if (granularity
== 0) {
855 granularity
= bdrv_get_default_bitmap_granularity(target
);
858 assert ((granularity
& (granularity
- 1)) == 0);
861 error_setg(errp
, "Invalid parameter 'buf-size'");
866 buf_size
= DEFAULT_MIRROR_BUF_SIZE
;
869 s
= block_job_create(job_id
, driver
, bs
, speed
, cb
, opaque
, errp
);
874 s
->target
= blk_new();
875 blk_insert_bs(s
->target
, target
);
877 s
->replaces
= g_strdup(replaces
);
878 s
->on_source_error
= on_source_error
;
879 s
->on_target_error
= on_target_error
;
880 s
->is_none_mode
= is_none_mode
;
881 s
->backing_mode
= backing_mode
;
883 s
->granularity
= granularity
;
884 s
->buf_size
= ROUND_UP(buf_size
, granularity
);
887 s
->dirty_bitmap
= bdrv_create_dirty_bitmap(bs
, granularity
, NULL
, errp
);
888 if (!s
->dirty_bitmap
) {
890 blk_unref(s
->target
);
891 block_job_unref(&s
->common
);
895 bdrv_op_block_all(target
, s
->common
.blocker
);
897 s
->common
.co
= qemu_coroutine_create(mirror_run
, s
);
898 trace_mirror_start(bs
, s
, s
->common
.co
, opaque
);
899 qemu_coroutine_enter(s
->common
.co
);
902 void mirror_start(const char *job_id
, BlockDriverState
*bs
,
903 BlockDriverState
*target
, const char *replaces
,
904 int64_t speed
, uint32_t granularity
, int64_t buf_size
,
905 MirrorSyncMode mode
, BlockMirrorBackingMode backing_mode
,
906 BlockdevOnError on_source_error
,
907 BlockdevOnError on_target_error
,
909 BlockCompletionFunc
*cb
,
910 void *opaque
, Error
**errp
)
913 BlockDriverState
*base
;
915 if (mode
== MIRROR_SYNC_MODE_INCREMENTAL
) {
916 error_setg(errp
, "Sync mode 'incremental' not supported");
919 is_none_mode
= mode
== MIRROR_SYNC_MODE_NONE
;
920 base
= mode
== MIRROR_SYNC_MODE_TOP
? backing_bs(bs
) : NULL
;
921 mirror_start_job(job_id
, bs
, target
, replaces
,
922 speed
, granularity
, buf_size
, backing_mode
,
923 on_source_error
, on_target_error
, unmap
, cb
, opaque
, errp
,
924 &mirror_job_driver
, is_none_mode
, base
);
927 void commit_active_start(const char *job_id
, BlockDriverState
*bs
,
928 BlockDriverState
*base
, int64_t speed
,
929 BlockdevOnError on_error
,
930 BlockCompletionFunc
*cb
,
931 void *opaque
, Error
**errp
)
933 int64_t length
, base_length
;
936 Error
*local_err
= NULL
;
938 orig_base_flags
= bdrv_get_flags(base
);
940 if (bdrv_reopen(base
, bs
->open_flags
, errp
)) {
944 length
= bdrv_getlength(bs
);
946 error_setg_errno(errp
, -length
,
947 "Unable to determine length of %s", bs
->filename
);
948 goto error_restore_flags
;
951 base_length
= bdrv_getlength(base
);
952 if (base_length
< 0) {
953 error_setg_errno(errp
, -base_length
,
954 "Unable to determine length of %s", base
->filename
);
955 goto error_restore_flags
;
958 if (length
> base_length
) {
959 ret
= bdrv_truncate(base
, length
);
961 error_setg_errno(errp
, -ret
,
962 "Top image %s is larger than base image %s, and "
963 "resize of base image failed",
964 bs
->filename
, base
->filename
);
965 goto error_restore_flags
;
969 mirror_start_job(job_id
, bs
, base
, NULL
, speed
, 0, 0,
970 MIRROR_LEAVE_BACKING_CHAIN
,
971 on_error
, on_error
, false, cb
, opaque
, &local_err
,
972 &commit_active_job_driver
, false, base
);
974 error_propagate(errp
, local_err
);
975 goto error_restore_flags
;
981 /* ignore error and errp for bdrv_reopen, because we want to propagate
982 * the original error */
983 bdrv_reopen(base
, orig_base_flags
, NULL
);