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_int.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 MAX_IO_SECTORS ((1 << 20) >> BDRV_SECTOR_BITS) /* 1 Mb */
27 #define DEFAULT_MIRROR_BUF_SIZE \
28 (MAX_IN_FLIGHT * MAX_IO_SECTORS * BDRV_SECTOR_SIZE)
30 /* The mirroring buffer is a list of granularity-sized chunks.
31 * Free chunks are organized in a list.
33 typedef struct MirrorBuffer
{
34 QSIMPLEQ_ENTRY(MirrorBuffer
) next
;
37 typedef struct MirrorBlockJob
{
41 BlockDriverState
*mirror_top_bs
;
42 BlockDriverState
*source
;
43 BlockDriverState
*base
;
45 /* The name of the graph node to replace */
47 /* The BDS to replace */
48 BlockDriverState
*to_replace
;
49 /* Used to block operations on the drive-mirror-replace target */
50 Error
*replace_blocker
;
52 BlockMirrorBackingMode backing_mode
;
53 BlockdevOnError on_source_error
, on_target_error
;
59 unsigned long *cow_bitmap
;
60 BdrvDirtyBitmap
*dirty_bitmap
;
61 BdrvDirtyBitmapIter
*dbi
;
63 QSIMPLEQ_HEAD(, MirrorBuffer
) buf_free
;
66 uint64_t last_pause_ns
;
67 unsigned long *in_flight_bitmap
;
69 int64_t sectors_in_flight
;
73 int target_cluster_sectors
;
75 bool initial_zeroing_ongoing
;
78 typedef struct MirrorOp
{
85 static BlockErrorAction
mirror_error_action(MirrorBlockJob
*s
, bool read
,
90 return block_job_error_action(&s
->common
, s
->on_source_error
,
93 return block_job_error_action(&s
->common
, s
->on_target_error
,
98 static void mirror_iteration_done(MirrorOp
*op
, int ret
)
100 MirrorBlockJob
*s
= op
->s
;
103 int i
, nb_chunks
, sectors_per_chunk
;
105 trace_mirror_iteration_done(s
, op
->sector_num
, op
->nb_sectors
, ret
);
108 s
->sectors_in_flight
-= op
->nb_sectors
;
110 for (i
= 0; i
< op
->qiov
.niov
; i
++) {
111 MirrorBuffer
*buf
= (MirrorBuffer
*) iov
[i
].iov_base
;
112 QSIMPLEQ_INSERT_TAIL(&s
->buf_free
, buf
, next
);
116 sectors_per_chunk
= s
->granularity
>> BDRV_SECTOR_BITS
;
117 chunk_num
= op
->sector_num
/ sectors_per_chunk
;
118 nb_chunks
= DIV_ROUND_UP(op
->nb_sectors
, sectors_per_chunk
);
119 bitmap_clear(s
->in_flight_bitmap
, chunk_num
, nb_chunks
);
122 bitmap_set(s
->cow_bitmap
, chunk_num
, nb_chunks
);
124 if (!s
->initial_zeroing_ongoing
) {
125 s
->common
.offset
+= (uint64_t)op
->nb_sectors
* BDRV_SECTOR_SIZE
;
128 qemu_iovec_destroy(&op
->qiov
);
131 if (s
->waiting_for_io
) {
132 qemu_coroutine_enter(s
->common
.co
);
136 static void mirror_write_complete(void *opaque
, int ret
)
138 MirrorOp
*op
= opaque
;
139 MirrorBlockJob
*s
= op
->s
;
141 aio_context_acquire(blk_get_aio_context(s
->common
.blk
));
143 BlockErrorAction action
;
145 bdrv_set_dirty_bitmap(s
->dirty_bitmap
, op
->sector_num
, op
->nb_sectors
);
146 action
= mirror_error_action(s
, false, -ret
);
147 if (action
== BLOCK_ERROR_ACTION_REPORT
&& s
->ret
>= 0) {
151 mirror_iteration_done(op
, ret
);
152 aio_context_release(blk_get_aio_context(s
->common
.blk
));
155 static void mirror_read_complete(void *opaque
, int ret
)
157 MirrorOp
*op
= opaque
;
158 MirrorBlockJob
*s
= op
->s
;
160 aio_context_acquire(blk_get_aio_context(s
->common
.blk
));
162 BlockErrorAction action
;
164 bdrv_set_dirty_bitmap(s
->dirty_bitmap
, op
->sector_num
, op
->nb_sectors
);
165 action
= mirror_error_action(s
, true, -ret
);
166 if (action
== BLOCK_ERROR_ACTION_REPORT
&& s
->ret
>= 0) {
170 mirror_iteration_done(op
, ret
);
172 blk_aio_pwritev(s
->target
, op
->sector_num
* BDRV_SECTOR_SIZE
, &op
->qiov
,
173 0, mirror_write_complete
, op
);
175 aio_context_release(blk_get_aio_context(s
->common
.blk
));
178 static inline void mirror_clip_sectors(MirrorBlockJob
*s
,
182 *nb_sectors
= MIN(*nb_sectors
,
183 s
->bdev_length
/ BDRV_SECTOR_SIZE
- sector_num
);
186 /* Round sector_num and/or nb_sectors to target cluster if COW is needed, and
187 * return the offset of the adjusted tail sector against original. */
188 static int mirror_cow_align(MirrorBlockJob
*s
,
194 int chunk_sectors
= s
->granularity
>> BDRV_SECTOR_BITS
;
195 int64_t align_sector_num
= *sector_num
;
196 int align_nb_sectors
= *nb_sectors
;
197 int max_sectors
= chunk_sectors
* s
->max_iov
;
199 need_cow
= !test_bit(*sector_num
/ chunk_sectors
, s
->cow_bitmap
);
200 need_cow
|= !test_bit((*sector_num
+ *nb_sectors
- 1) / chunk_sectors
,
203 bdrv_round_sectors_to_clusters(blk_bs(s
->target
), *sector_num
,
204 *nb_sectors
, &align_sector_num
,
208 if (align_nb_sectors
> max_sectors
) {
209 align_nb_sectors
= max_sectors
;
211 align_nb_sectors
= QEMU_ALIGN_DOWN(align_nb_sectors
,
212 s
->target_cluster_sectors
);
215 /* Clipping may result in align_nb_sectors unaligned to chunk boundary, but
216 * that doesn't matter because it's already the end of source image. */
217 mirror_clip_sectors(s
, align_sector_num
, &align_nb_sectors
);
219 ret
= align_sector_num
+ align_nb_sectors
- (*sector_num
+ *nb_sectors
);
220 *sector_num
= align_sector_num
;
221 *nb_sectors
= align_nb_sectors
;
226 static inline void mirror_wait_for_io(MirrorBlockJob
*s
)
228 assert(!s
->waiting_for_io
);
229 s
->waiting_for_io
= true;
230 qemu_coroutine_yield();
231 s
->waiting_for_io
= false;
234 /* Submit async read while handling COW.
235 * Returns: The number of sectors copied after and including sector_num,
236 * excluding any sectors copied prior to sector_num due to alignment.
237 * This will be nb_sectors if no alignment is necessary, or
238 * (new_end - sector_num) if tail is rounded up or down due to
239 * alignment or buffer limit.
241 static int mirror_do_read(MirrorBlockJob
*s
, int64_t sector_num
,
244 BlockBackend
*source
= s
->common
.blk
;
245 int sectors_per_chunk
, nb_chunks
;
250 sectors_per_chunk
= s
->granularity
>> BDRV_SECTOR_BITS
;
251 max_sectors
= sectors_per_chunk
* s
->max_iov
;
253 /* We can only handle as much as buf_size at a time. */
254 nb_sectors
= MIN(s
->buf_size
>> BDRV_SECTOR_BITS
, nb_sectors
);
255 nb_sectors
= MIN(max_sectors
, nb_sectors
);
260 ret
+= mirror_cow_align(s
, §or_num
, &nb_sectors
);
262 assert(nb_sectors
<< BDRV_SECTOR_BITS
<= s
->buf_size
);
263 /* The sector range must meet granularity because:
264 * 1) Caller passes in aligned values;
265 * 2) mirror_cow_align is used only when target cluster is larger. */
266 assert(!(sector_num
% sectors_per_chunk
));
267 nb_chunks
= DIV_ROUND_UP(nb_sectors
, sectors_per_chunk
);
269 while (s
->buf_free_count
< nb_chunks
) {
270 trace_mirror_yield_in_flight(s
, sector_num
, s
->in_flight
);
271 mirror_wait_for_io(s
);
274 /* Allocate a MirrorOp that is used as an AIO callback. */
275 op
= g_new(MirrorOp
, 1);
277 op
->sector_num
= sector_num
;
278 op
->nb_sectors
= nb_sectors
;
280 /* Now make a QEMUIOVector taking enough granularity-sized chunks
283 qemu_iovec_init(&op
->qiov
, nb_chunks
);
284 while (nb_chunks
-- > 0) {
285 MirrorBuffer
*buf
= QSIMPLEQ_FIRST(&s
->buf_free
);
286 size_t remaining
= nb_sectors
* BDRV_SECTOR_SIZE
- op
->qiov
.size
;
288 QSIMPLEQ_REMOVE_HEAD(&s
->buf_free
, next
);
290 qemu_iovec_add(&op
->qiov
, buf
, MIN(s
->granularity
, remaining
));
293 /* Copy the dirty cluster. */
295 s
->sectors_in_flight
+= nb_sectors
;
296 trace_mirror_one_iteration(s
, sector_num
, nb_sectors
);
298 blk_aio_preadv(source
, sector_num
* BDRV_SECTOR_SIZE
, &op
->qiov
, 0,
299 mirror_read_complete
, op
);
303 static void mirror_do_zero_or_discard(MirrorBlockJob
*s
,
310 /* Allocate a MirrorOp that is used as an AIO callback. The qiov is zeroed
311 * so the freeing in mirror_iteration_done is nop. */
312 op
= g_new0(MirrorOp
, 1);
314 op
->sector_num
= sector_num
;
315 op
->nb_sectors
= nb_sectors
;
318 s
->sectors_in_flight
+= nb_sectors
;
320 blk_aio_pdiscard(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
321 op
->nb_sectors
<< BDRV_SECTOR_BITS
,
322 mirror_write_complete
, op
);
324 blk_aio_pwrite_zeroes(s
->target
, sector_num
* BDRV_SECTOR_SIZE
,
325 op
->nb_sectors
* BDRV_SECTOR_SIZE
,
326 s
->unmap
? BDRV_REQ_MAY_UNMAP
: 0,
327 mirror_write_complete
, op
);
331 static uint64_t coroutine_fn
mirror_iteration(MirrorBlockJob
*s
)
333 BlockDriverState
*source
= s
->source
;
334 int64_t sector_num
, first_chunk
;
335 uint64_t delay_ns
= 0;
336 /* At least the first dirty chunk is mirrored in one iteration. */
338 int64_t end
= s
->bdev_length
/ BDRV_SECTOR_SIZE
;
339 int sectors_per_chunk
= s
->granularity
>> BDRV_SECTOR_BITS
;
340 bool write_zeroes_ok
= bdrv_can_write_zeroes_with_unmap(blk_bs(s
->target
));
341 int max_io_sectors
= MAX((s
->buf_size
>> BDRV_SECTOR_BITS
) / MAX_IN_FLIGHT
,
344 sector_num
= bdrv_dirty_iter_next(s
->dbi
);
345 if (sector_num
< 0) {
346 bdrv_set_dirty_iter(s
->dbi
, 0);
347 sector_num
= bdrv_dirty_iter_next(s
->dbi
);
348 trace_mirror_restart_iter(s
, bdrv_get_dirty_count(s
->dirty_bitmap
));
349 assert(sector_num
>= 0);
352 first_chunk
= sector_num
/ sectors_per_chunk
;
353 while (test_bit(first_chunk
, s
->in_flight_bitmap
)) {
354 trace_mirror_yield_in_flight(s
, sector_num
, s
->in_flight
);
355 mirror_wait_for_io(s
);
358 block_job_pause_point(&s
->common
);
360 /* Find the number of consective dirty chunks following the first dirty
361 * one, and wait for in flight requests in them. */
362 while (nb_chunks
* sectors_per_chunk
< (s
->buf_size
>> BDRV_SECTOR_BITS
)) {
364 int64_t next_sector
= sector_num
+ nb_chunks
* sectors_per_chunk
;
365 int64_t next_chunk
= next_sector
/ sectors_per_chunk
;
366 if (next_sector
>= end
||
367 !bdrv_get_dirty(source
, s
->dirty_bitmap
, next_sector
)) {
370 if (test_bit(next_chunk
, s
->in_flight_bitmap
)) {
374 next_dirty
= bdrv_dirty_iter_next(s
->dbi
);
375 if (next_dirty
> next_sector
|| next_dirty
< 0) {
376 /* The bitmap iterator's cache is stale, refresh it */
377 bdrv_set_dirty_iter(s
->dbi
, next_sector
);
378 next_dirty
= bdrv_dirty_iter_next(s
->dbi
);
380 assert(next_dirty
== next_sector
);
384 /* Clear dirty bits before querying the block status, because
385 * calling bdrv_get_block_status_above could yield - if some blocks are
386 * marked dirty in this window, we need to know.
388 bdrv_reset_dirty_bitmap(s
->dirty_bitmap
, sector_num
,
389 nb_chunks
* sectors_per_chunk
);
390 bitmap_set(s
->in_flight_bitmap
, sector_num
/ sectors_per_chunk
, nb_chunks
);
391 while (nb_chunks
> 0 && sector_num
< end
) {
393 int io_sectors
, io_sectors_acct
;
394 BlockDriverState
*file
;
398 MIRROR_METHOD_DISCARD
399 } mirror_method
= MIRROR_METHOD_COPY
;
401 assert(!(sector_num
% sectors_per_chunk
));
402 ret
= bdrv_get_block_status_above(source
, NULL
, sector_num
,
403 nb_chunks
* sectors_per_chunk
,
406 io_sectors
= MIN(nb_chunks
* sectors_per_chunk
, max_io_sectors
);
407 } else if (ret
& BDRV_BLOCK_DATA
) {
408 io_sectors
= MIN(io_sectors
, max_io_sectors
);
411 io_sectors
-= io_sectors
% sectors_per_chunk
;
412 if (io_sectors
< sectors_per_chunk
) {
413 io_sectors
= sectors_per_chunk
;
414 } else if (ret
>= 0 && !(ret
& BDRV_BLOCK_DATA
)) {
415 int64_t target_sector_num
;
416 int target_nb_sectors
;
417 bdrv_round_sectors_to_clusters(blk_bs(s
->target
), sector_num
,
418 io_sectors
, &target_sector_num
,
420 if (target_sector_num
== sector_num
&&
421 target_nb_sectors
== io_sectors
) {
422 mirror_method
= ret
& BDRV_BLOCK_ZERO
?
424 MIRROR_METHOD_DISCARD
;
428 while (s
->in_flight
>= MAX_IN_FLIGHT
) {
429 trace_mirror_yield_in_flight(s
, sector_num
, s
->in_flight
);
430 mirror_wait_for_io(s
);
437 mirror_clip_sectors(s
, sector_num
, &io_sectors
);
438 switch (mirror_method
) {
439 case MIRROR_METHOD_COPY
:
440 io_sectors
= mirror_do_read(s
, sector_num
, io_sectors
);
441 io_sectors_acct
= io_sectors
;
443 case MIRROR_METHOD_ZERO
:
444 case MIRROR_METHOD_DISCARD
:
445 mirror_do_zero_or_discard(s
, sector_num
, io_sectors
,
446 mirror_method
== MIRROR_METHOD_DISCARD
);
447 if (write_zeroes_ok
) {
450 io_sectors_acct
= io_sectors
;
457 sector_num
+= io_sectors
;
458 nb_chunks
-= DIV_ROUND_UP(io_sectors
, sectors_per_chunk
);
459 if (s
->common
.speed
) {
460 delay_ns
= ratelimit_calculate_delay(&s
->limit
, io_sectors_acct
);
466 static void mirror_free_init(MirrorBlockJob
*s
)
468 int granularity
= s
->granularity
;
469 size_t buf_size
= s
->buf_size
;
470 uint8_t *buf
= s
->buf
;
472 assert(s
->buf_free_count
== 0);
473 QSIMPLEQ_INIT(&s
->buf_free
);
474 while (buf_size
!= 0) {
475 MirrorBuffer
*cur
= (MirrorBuffer
*)buf
;
476 QSIMPLEQ_INSERT_TAIL(&s
->buf_free
, cur
, next
);
478 buf_size
-= granularity
;
483 /* This is also used for the .pause callback. There is no matching
484 * mirror_resume() because mirror_run() will begin iterating again
485 * when the job is resumed.
487 static void mirror_wait_for_all_io(MirrorBlockJob
*s
)
489 while (s
->in_flight
> 0) {
490 mirror_wait_for_io(s
);
498 static void mirror_exit(BlockJob
*job
, void *opaque
)
500 MirrorBlockJob
*s
= container_of(job
, MirrorBlockJob
, common
);
501 MirrorExitData
*data
= opaque
;
502 AioContext
*replace_aio_context
= NULL
;
503 BlockDriverState
*src
= s
->source
;
504 BlockDriverState
*target_bs
= blk_bs(s
->target
);
505 BlockDriverState
*mirror_top_bs
= s
->mirror_top_bs
;
506 Error
*local_err
= NULL
;
508 /* Make sure that the source BDS doesn't go away before we called
509 * block_job_completed(). */
511 bdrv_ref(mirror_top_bs
);
514 /* Remove target parent that still uses BLK_PERM_WRITE/RESIZE before
515 * inserting target_bs at s->to_replace, where we might not be able to get
516 * these permissions. */
517 blk_unref(s
->target
);
520 /* We don't access the source any more. Dropping any WRITE/RESIZE is
521 * required before it could become a backing file of target_bs. */
522 bdrv_child_try_set_perm(mirror_top_bs
->backing
, 0, BLK_PERM_ALL
,
524 if (s
->backing_mode
== MIRROR_SOURCE_BACKING_CHAIN
) {
525 BlockDriverState
*backing
= s
->is_none_mode
? src
: s
->base
;
526 if (backing_bs(target_bs
) != backing
) {
527 bdrv_set_backing_hd(target_bs
, backing
, &local_err
);
529 error_report_err(local_err
);
536 replace_aio_context
= bdrv_get_aio_context(s
->to_replace
);
537 aio_context_acquire(replace_aio_context
);
540 if (s
->should_complete
&& data
->ret
== 0) {
541 BlockDriverState
*to_replace
= src
;
543 to_replace
= s
->to_replace
;
546 if (bdrv_get_flags(target_bs
) != bdrv_get_flags(to_replace
)) {
547 bdrv_reopen(target_bs
, bdrv_get_flags(to_replace
), NULL
);
550 /* The mirror job has no requests in flight any more, but we need to
551 * drain potential other users of the BDS before changing the graph. */
552 bdrv_drained_begin(target_bs
);
553 bdrv_replace_in_backing_chain(to_replace
, target_bs
);
554 bdrv_drained_end(target_bs
);
557 bdrv_op_unblock_all(s
->to_replace
, s
->replace_blocker
);
558 error_free(s
->replace_blocker
);
559 bdrv_unref(s
->to_replace
);
561 if (replace_aio_context
) {
562 aio_context_release(replace_aio_context
);
565 bdrv_unref(target_bs
);
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
570 block_job_remove_all_bdrv(job
);
571 bdrv_replace_in_backing_chain(mirror_top_bs
, backing_bs(mirror_top_bs
));
573 /* We just changed the BDS the job BB refers to (with either or both of the
574 * bdrv_replace_in_backing_chain() calls), so switch the BB back so the
575 * cleanup does the right thing. We don't need any permissions any more
577 blk_remove_bs(job
->blk
);
578 blk_set_perm(job
->blk
, 0, BLK_PERM_ALL
, &error_abort
);
579 blk_insert_bs(job
->blk
, mirror_top_bs
, &error_abort
);
581 block_job_completed(&s
->common
, data
->ret
);
584 bdrv_drained_end(src
);
585 bdrv_unref(mirror_top_bs
);
589 static void mirror_throttle(MirrorBlockJob
*s
)
591 int64_t now
= qemu_clock_get_ns(QEMU_CLOCK_REALTIME
);
593 if (now
- s
->last_pause_ns
> SLICE_TIME
) {
594 s
->last_pause_ns
= now
;
595 block_job_sleep_ns(&s
->common
, QEMU_CLOCK_REALTIME
, 0);
597 block_job_pause_point(&s
->common
);
601 static int coroutine_fn
mirror_dirty_init(MirrorBlockJob
*s
)
603 int64_t sector_num
, end
;
604 BlockDriverState
*base
= s
->base
;
605 BlockDriverState
*bs
= s
->source
;
606 BlockDriverState
*target_bs
= blk_bs(s
->target
);
609 end
= s
->bdev_length
/ BDRV_SECTOR_SIZE
;
611 if (base
== NULL
&& !bdrv_has_zero_init(target_bs
)) {
612 if (!bdrv_can_write_zeroes_with_unmap(target_bs
)) {
613 bdrv_set_dirty_bitmap(s
->dirty_bitmap
, 0, end
);
617 s
->initial_zeroing_ongoing
= true;
618 for (sector_num
= 0; sector_num
< end
; ) {
619 int nb_sectors
= MIN(end
- sector_num
,
620 QEMU_ALIGN_DOWN(INT_MAX
, s
->granularity
) >> BDRV_SECTOR_BITS
);
624 if (block_job_is_cancelled(&s
->common
)) {
625 s
->initial_zeroing_ongoing
= false;
629 if (s
->in_flight
>= MAX_IN_FLIGHT
) {
630 trace_mirror_yield(s
, s
->in_flight
, s
->buf_free_count
, -1);
631 mirror_wait_for_io(s
);
635 mirror_do_zero_or_discard(s
, sector_num
, nb_sectors
, false);
636 sector_num
+= nb_sectors
;
639 mirror_wait_for_all_io(s
);
640 s
->initial_zeroing_ongoing
= false;
643 /* First part, loop on the sectors and initialize the dirty bitmap. */
644 for (sector_num
= 0; sector_num
< end
; ) {
645 /* Just to make sure we are not exceeding int limit. */
646 int nb_sectors
= MIN(INT_MAX
>> BDRV_SECTOR_BITS
,
651 if (block_job_is_cancelled(&s
->common
)) {
655 ret
= bdrv_is_allocated_above(bs
, base
, sector_num
, nb_sectors
, &n
);
662 bdrv_set_dirty_bitmap(s
->dirty_bitmap
, sector_num
, n
);
669 /* Called when going out of the streaming phase to flush the bulk of the
670 * data to the medium, or just before completing.
672 static int mirror_flush(MirrorBlockJob
*s
)
674 int ret
= blk_flush(s
->target
);
676 if (mirror_error_action(s
, false, -ret
) == BLOCK_ERROR_ACTION_REPORT
) {
683 static void coroutine_fn
mirror_run(void *opaque
)
685 MirrorBlockJob
*s
= opaque
;
686 MirrorExitData
*data
;
687 BlockDriverState
*bs
= s
->source
;
688 BlockDriverState
*target_bs
= blk_bs(s
->target
);
689 bool need_drain
= true;
692 char backing_filename
[2]; /* we only need 2 characters because we are only
693 checking for a NULL string */
695 int target_cluster_size
= BDRV_SECTOR_SIZE
;
697 if (block_job_is_cancelled(&s
->common
)) {
701 s
->bdev_length
= bdrv_getlength(bs
);
702 if (s
->bdev_length
< 0) {
703 ret
= s
->bdev_length
;
707 /* Active commit must resize the base image if its size differs from the
709 if (s
->base
== blk_bs(s
->target
)) {
712 base_length
= blk_getlength(s
->target
);
713 if (base_length
< 0) {
718 if (s
->bdev_length
> base_length
) {
719 ret
= blk_truncate(s
->target
, s
->bdev_length
);
726 if (s
->bdev_length
== 0) {
727 /* Report BLOCK_JOB_READY and wait for complete. */
728 block_job_event_ready(&s
->common
);
730 while (!block_job_is_cancelled(&s
->common
) && !s
->should_complete
) {
731 block_job_yield(&s
->common
);
733 s
->common
.cancelled
= false;
737 length
= DIV_ROUND_UP(s
->bdev_length
, s
->granularity
);
738 s
->in_flight_bitmap
= bitmap_new(length
);
740 /* If we have no backing file yet in the destination, we cannot let
741 * the destination do COW. Instead, we copy sectors around the
742 * dirty data if needed. We need a bitmap to do that.
744 bdrv_get_backing_filename(target_bs
, backing_filename
,
745 sizeof(backing_filename
));
746 if (!bdrv_get_info(target_bs
, &bdi
) && bdi
.cluster_size
) {
747 target_cluster_size
= bdi
.cluster_size
;
749 if (backing_filename
[0] && !target_bs
->backing
750 && s
->granularity
< target_cluster_size
) {
751 s
->buf_size
= MAX(s
->buf_size
, target_cluster_size
);
752 s
->cow_bitmap
= bitmap_new(length
);
754 s
->target_cluster_sectors
= target_cluster_size
>> BDRV_SECTOR_BITS
;
755 s
->max_iov
= MIN(bs
->bl
.max_iov
, target_bs
->bl
.max_iov
);
757 s
->buf
= qemu_try_blockalign(bs
, s
->buf_size
);
758 if (s
->buf
== NULL
) {
765 s
->last_pause_ns
= qemu_clock_get_ns(QEMU_CLOCK_REALTIME
);
766 if (!s
->is_none_mode
) {
767 ret
= mirror_dirty_init(s
);
768 if (ret
< 0 || block_job_is_cancelled(&s
->common
)) {
774 s
->dbi
= bdrv_dirty_iter_new(s
->dirty_bitmap
, 0);
776 uint64_t delay_ns
= 0;
778 bool should_complete
;
785 block_job_pause_point(&s
->common
);
787 cnt
= bdrv_get_dirty_count(s
->dirty_bitmap
);
788 /* s->common.offset contains the number of bytes already processed so
789 * far, cnt is the number of dirty sectors remaining and
790 * s->sectors_in_flight is the number of sectors currently being
791 * processed; together those are the current total operation length */
792 s
->common
.len
= s
->common
.offset
+
793 (cnt
+ s
->sectors_in_flight
) * BDRV_SECTOR_SIZE
;
795 /* Note that even when no rate limit is applied we need to yield
796 * periodically with no pending I/O so that bdrv_drain_all() returns.
797 * We do so every SLICE_TIME nanoseconds, or when there is an error,
798 * 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
< 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
, s
->in_flight
, s
->buf_free_count
, cnt
);
806 mirror_wait_for_io(s
);
808 } else if (cnt
!= 0) {
809 delay_ns
= mirror_iteration(s
);
813 should_complete
= false;
814 if (s
->in_flight
== 0 && cnt
== 0) {
815 trace_mirror_before_flush(s
);
817 if (mirror_flush(s
) < 0) {
818 /* Go check s->ret. */
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.
826 block_job_event_ready(&s
->common
);
830 should_complete
= s
->should_complete
||
831 block_job_is_cancelled(&s
->common
);
832 cnt
= bdrv_get_dirty_count(s
->dirty_bitmap
);
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!
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.
846 trace_mirror_before_drain(s
, cnt
);
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
);
855 /* The two disks are in sync. Exit and report successful
858 assert(QLIST_EMPTY(&bs
->tracked_requests
));
859 s
->common
.cancelled
= false;
865 trace_mirror_before_sleep(s
, cnt
, s
->synced
, delay_ns
);
867 block_job_sleep_ns(&s
->common
, QEMU_CLOCK_REALTIME
, delay_ns
);
868 if (block_job_is_cancelled(&s
->common
)) {
871 } else if (!should_complete
) {
872 delay_ns
= (s
->in_flight
== 0 && cnt
== 0 ? SLICE_TIME
: 0);
873 block_job_sleep_ns(&s
->common
, QEMU_CLOCK_REALTIME
, delay_ns
);
875 s
->last_pause_ns
= qemu_clock_get_ns(QEMU_CLOCK_REALTIME
);
879 if (s
->in_flight
> 0) {
880 /* We get here only if something went wrong. Either the job failed,
881 * or it was cancelled prematurely so that we do not guarantee that
882 * the target is a copy of the source.
884 assert(ret
< 0 || (!s
->synced
&& block_job_is_cancelled(&s
->common
)));
886 mirror_wait_for_all_io(s
);
889 assert(s
->in_flight
== 0);
891 g_free(s
->cow_bitmap
);
892 g_free(s
->in_flight_bitmap
);
893 bdrv_dirty_iter_free(s
->dbi
);
894 bdrv_release_dirty_bitmap(bs
, s
->dirty_bitmap
);
896 data
= g_malloc(sizeof(*data
));
900 bdrv_drained_begin(bs
);
902 block_job_defer_to_main_loop(&s
->common
, mirror_exit
, data
);
905 static void mirror_set_speed(BlockJob
*job
, int64_t speed
, Error
**errp
)
907 MirrorBlockJob
*s
= container_of(job
, MirrorBlockJob
, common
);
910 error_setg(errp
, QERR_INVALID_PARAMETER
, "speed");
913 ratelimit_set_speed(&s
->limit
, speed
/ BDRV_SECTOR_SIZE
, SLICE_TIME
);
916 static void mirror_complete(BlockJob
*job
, Error
**errp
)
918 MirrorBlockJob
*s
= container_of(job
, MirrorBlockJob
, common
);
919 BlockDriverState
*target
;
921 target
= blk_bs(s
->target
);
924 error_setg(errp
, "The active block job '%s' cannot be completed",
929 if (s
->backing_mode
== MIRROR_OPEN_BACKING_CHAIN
) {
932 assert(!target
->backing
);
933 ret
= bdrv_open_backing_file(target
, NULL
, "backing", errp
);
939 /* block all operations on to_replace bs */
941 AioContext
*replace_aio_context
;
943 s
->to_replace
= bdrv_find_node(s
->replaces
);
944 if (!s
->to_replace
) {
945 error_setg(errp
, "Node name '%s' not found", s
->replaces
);
949 replace_aio_context
= bdrv_get_aio_context(s
->to_replace
);
950 aio_context_acquire(replace_aio_context
);
952 /* TODO Translate this into permission system. Current definition of
953 * GRAPH_MOD would require to request it for the parents; they might
954 * not even be BlockDriverStates, however, so a BdrvChild can't address
955 * them. May need redefinition of GRAPH_MOD. */
956 error_setg(&s
->replace_blocker
,
957 "block device is in use by block-job-complete");
958 bdrv_op_block_all(s
->to_replace
, s
->replace_blocker
);
959 bdrv_ref(s
->to_replace
);
961 aio_context_release(replace_aio_context
);
964 s
->should_complete
= true;
965 block_job_enter(&s
->common
);
968 static void mirror_pause(BlockJob
*job
)
970 MirrorBlockJob
*s
= container_of(job
, MirrorBlockJob
, common
);
972 mirror_wait_for_all_io(s
);
975 static void mirror_attached_aio_context(BlockJob
*job
, AioContext
*new_context
)
977 MirrorBlockJob
*s
= container_of(job
, MirrorBlockJob
, common
);
979 blk_set_aio_context(s
->target
, new_context
);
982 static void mirror_drain(BlockJob
*job
)
984 MirrorBlockJob
*s
= container_of(job
, MirrorBlockJob
, common
);
986 /* Need to keep a reference in case blk_drain triggers execution
987 * of mirror_complete...
990 BlockBackend
*target
= s
->target
;
997 static const BlockJobDriver mirror_job_driver
= {
998 .instance_size
= sizeof(MirrorBlockJob
),
999 .job_type
= BLOCK_JOB_TYPE_MIRROR
,
1000 .set_speed
= mirror_set_speed
,
1001 .start
= mirror_run
,
1002 .complete
= mirror_complete
,
1003 .pause
= mirror_pause
,
1004 .attached_aio_context
= mirror_attached_aio_context
,
1005 .drain
= mirror_drain
,
1008 static const BlockJobDriver commit_active_job_driver
= {
1009 .instance_size
= sizeof(MirrorBlockJob
),
1010 .job_type
= BLOCK_JOB_TYPE_COMMIT
,
1011 .set_speed
= mirror_set_speed
,
1012 .start
= mirror_run
,
1013 .complete
= mirror_complete
,
1014 .pause
= mirror_pause
,
1015 .attached_aio_context
= mirror_attached_aio_context
,
1016 .drain
= mirror_drain
,
1019 static int coroutine_fn
bdrv_mirror_top_preadv(BlockDriverState
*bs
,
1020 uint64_t offset
, uint64_t bytes
, QEMUIOVector
*qiov
, int flags
)
1022 return bdrv_co_preadv(bs
->backing
, offset
, bytes
, qiov
, flags
);
1025 static int coroutine_fn
bdrv_mirror_top_pwritev(BlockDriverState
*bs
,
1026 uint64_t offset
, uint64_t bytes
, QEMUIOVector
*qiov
, int flags
)
1028 return bdrv_co_pwritev(bs
->backing
, offset
, bytes
, qiov
, flags
);
1031 static int coroutine_fn
bdrv_mirror_top_flush(BlockDriverState
*bs
)
1033 return bdrv_co_flush(bs
->backing
->bs
);
1036 static int64_t coroutine_fn
bdrv_mirror_top_get_block_status(
1037 BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
, int *pnum
,
1038 BlockDriverState
**file
)
1041 *file
= bs
->backing
->bs
;
1042 return BDRV_BLOCK_RAW
| BDRV_BLOCK_OFFSET_VALID
| BDRV_BLOCK_DATA
|
1043 (sector_num
<< BDRV_SECTOR_BITS
);
1046 static int coroutine_fn
bdrv_mirror_top_pwrite_zeroes(BlockDriverState
*bs
,
1047 int64_t offset
, int count
, BdrvRequestFlags flags
)
1049 return bdrv_co_pwrite_zeroes(bs
->backing
, offset
, count
, flags
);
1052 static int coroutine_fn
bdrv_mirror_top_pdiscard(BlockDriverState
*bs
,
1053 int64_t offset
, int count
)
1055 return bdrv_co_pdiscard(bs
->backing
->bs
, offset
, count
);
1058 static void bdrv_mirror_top_close(BlockDriverState
*bs
)
1062 static void bdrv_mirror_top_child_perm(BlockDriverState
*bs
, BdrvChild
*c
,
1063 const BdrvChildRole
*role
,
1064 uint64_t perm
, uint64_t shared
,
1065 uint64_t *nperm
, uint64_t *nshared
)
1067 /* Must be able to forward guest writes to the real image */
1069 if (perm
& BLK_PERM_WRITE
) {
1070 *nperm
|= BLK_PERM_WRITE
;
1073 *nshared
= BLK_PERM_ALL
;
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_get_block_status
= bdrv_mirror_top_get_block_status
,
1086 .bdrv_close
= bdrv_mirror_top_close
,
1087 .bdrv_child_perm
= bdrv_mirror_top_child_perm
,
1090 static void mirror_start_job(const char *job_id
, BlockDriverState
*bs
,
1091 int creation_flags
, BlockDriverState
*target
,
1092 const char *replaces
, int64_t speed
,
1093 uint32_t granularity
, int64_t buf_size
,
1094 BlockMirrorBackingMode backing_mode
,
1095 BlockdevOnError on_source_error
,
1096 BlockdevOnError on_target_error
,
1098 BlockCompletionFunc
*cb
,
1099 void *opaque
, Error
**errp
,
1100 const BlockJobDriver
*driver
,
1101 bool is_none_mode
, BlockDriverState
*base
,
1102 bool auto_complete
, const char *filter_node_name
)
1105 BlockDriverState
*mirror_top_bs
;
1106 bool target_graph_mod
;
1107 bool target_is_backing
;
1108 Error
*local_err
= NULL
;
1111 if (granularity
== 0) {
1112 granularity
= bdrv_get_default_bitmap_granularity(target
);
1115 assert ((granularity
& (granularity
- 1)) == 0);
1118 error_setg(errp
, "Invalid parameter 'buf-size'");
1122 if (buf_size
== 0) {
1123 buf_size
= DEFAULT_MIRROR_BUF_SIZE
;
1126 /* In the case of active commit, add dummy driver to provide consistent
1127 * reads on the top, while disabling it in the intermediate nodes, and make
1128 * the backing chain writable. */
1129 mirror_top_bs
= bdrv_new_open_driver(&bdrv_mirror_top
, filter_node_name
,
1131 if (mirror_top_bs
== NULL
) {
1134 mirror_top_bs
->total_sectors
= bs
->total_sectors
;
1136 /* bdrv_append takes ownership of the mirror_top_bs reference, need to keep
1137 * it alive until block_job_create() even if bs has no parent. */
1138 bdrv_ref(mirror_top_bs
);
1139 bdrv_drained_begin(bs
);
1140 bdrv_append(mirror_top_bs
, bs
, &local_err
);
1141 bdrv_drained_end(bs
);
1144 bdrv_unref(mirror_top_bs
);
1145 error_propagate(errp
, local_err
);
1149 /* Make sure that the source is not resized while the job is running */
1150 s
= block_job_create(job_id
, driver
, mirror_top_bs
,
1151 BLK_PERM_CONSISTENT_READ
,
1152 BLK_PERM_CONSISTENT_READ
| BLK_PERM_WRITE_UNCHANGED
|
1153 BLK_PERM_WRITE
| BLK_PERM_GRAPH_MOD
, speed
,
1154 creation_flags
, cb
, opaque
, errp
);
1155 bdrv_unref(mirror_top_bs
);
1160 s
->mirror_top_bs
= mirror_top_bs
;
1162 /* No resize for the target either; while the mirror is still running, a
1163 * consistent read isn't necessarily possible. We could possibly allow
1164 * writes and graph modifications, though it would likely defeat the
1165 * purpose of a mirror, so leave them blocked for now.
1167 * In the case of active commit, things look a bit different, though,
1168 * because the target is an already populated backing file in active use.
1169 * We can allow anything except resize there.*/
1170 target_is_backing
= bdrv_chain_contains(bs
, target
);
1171 target_graph_mod
= (backing_mode
!= MIRROR_LEAVE_BACKING_CHAIN
);
1172 s
->target
= blk_new(BLK_PERM_WRITE
| BLK_PERM_RESIZE
|
1173 (target_graph_mod
? BLK_PERM_GRAPH_MOD
: 0),
1174 BLK_PERM_WRITE_UNCHANGED
|
1175 (target_is_backing
? BLK_PERM_CONSISTENT_READ
|
1177 BLK_PERM_GRAPH_MOD
: 0));
1178 ret
= blk_insert_bs(s
->target
, target
, errp
);
1183 s
->replaces
= g_strdup(replaces
);
1184 s
->on_source_error
= on_source_error
;
1185 s
->on_target_error
= on_target_error
;
1186 s
->is_none_mode
= is_none_mode
;
1187 s
->backing_mode
= backing_mode
;
1189 s
->granularity
= granularity
;
1190 s
->buf_size
= ROUND_UP(buf_size
, granularity
);
1192 if (auto_complete
) {
1193 s
->should_complete
= true;
1196 s
->dirty_bitmap
= bdrv_create_dirty_bitmap(bs
, granularity
, NULL
, errp
);
1197 if (!s
->dirty_bitmap
) {
1198 g_free(s
->replaces
);
1199 blk_unref(s
->target
);
1200 block_job_unref(&s
->common
);
1204 /* Required permissions are already taken with blk_new() */
1205 block_job_add_bdrv(&s
->common
, "target", target
, 0, BLK_PERM_ALL
,
1208 /* In commit_active_start() all intermediate nodes disappear, so
1209 * any jobs in them must be blocked */
1210 if (target_is_backing
) {
1211 BlockDriverState
*iter
;
1212 for (iter
= backing_bs(bs
); iter
!= target
; iter
= backing_bs(iter
)) {
1213 /* XXX BLK_PERM_WRITE needs to be allowed so we don't block
1214 * ourselves at s->base (if writes are blocked for a node, they are
1215 * also blocked for its backing file). The other options would be a
1216 * second filter driver above s->base (== target). */
1217 ret
= block_job_add_bdrv(&s
->common
, "intermediate node", iter
, 0,
1218 BLK_PERM_WRITE_UNCHANGED
| BLK_PERM_WRITE
,
1226 trace_mirror_start(bs
, s
, opaque
);
1227 block_job_start(&s
->common
);
1232 g_free(s
->replaces
);
1233 blk_unref(s
->target
);
1234 block_job_unref(&s
->common
);
1237 bdrv_replace_in_backing_chain(mirror_top_bs
, backing_bs(mirror_top_bs
));
1240 void mirror_start(const char *job_id
, BlockDriverState
*bs
,
1241 BlockDriverState
*target
, const char *replaces
,
1242 int64_t speed
, uint32_t granularity
, int64_t buf_size
,
1243 MirrorSyncMode mode
, BlockMirrorBackingMode backing_mode
,
1244 BlockdevOnError on_source_error
,
1245 BlockdevOnError on_target_error
,
1246 bool unmap
, const char *filter_node_name
, Error
**errp
)
1249 BlockDriverState
*base
;
1251 if (mode
== MIRROR_SYNC_MODE_INCREMENTAL
) {
1252 error_setg(errp
, "Sync mode 'incremental' not supported");
1255 is_none_mode
= mode
== MIRROR_SYNC_MODE_NONE
;
1256 base
= mode
== MIRROR_SYNC_MODE_TOP
? backing_bs(bs
) : NULL
;
1257 mirror_start_job(job_id
, bs
, BLOCK_JOB_DEFAULT
, target
, replaces
,
1258 speed
, granularity
, buf_size
, backing_mode
,
1259 on_source_error
, on_target_error
, unmap
, NULL
, NULL
, errp
,
1260 &mirror_job_driver
, is_none_mode
, base
, false,
1264 void commit_active_start(const char *job_id
, BlockDriverState
*bs
,
1265 BlockDriverState
*base
, int creation_flags
,
1266 int64_t speed
, BlockdevOnError on_error
,
1267 const char *filter_node_name
,
1268 BlockCompletionFunc
*cb
, void *opaque
, Error
**errp
,
1271 int orig_base_flags
;
1272 Error
*local_err
= NULL
;
1274 orig_base_flags
= bdrv_get_flags(base
);
1276 if (bdrv_reopen(base
, bs
->open_flags
, errp
)) {
1280 mirror_start_job(job_id
, bs
, creation_flags
, base
, NULL
, speed
, 0, 0,
1281 MIRROR_LEAVE_BACKING_CHAIN
,
1282 on_error
, on_error
, true, cb
, opaque
, &local_err
,
1283 &commit_active_job_driver
, false, base
, auto_complete
,
1286 error_propagate(errp
, local_err
);
1287 goto error_restore_flags
;
1292 error_restore_flags
:
1293 /* ignore error and errp for bdrv_reopen, because we want to propagate
1294 * the original error */
1295 bdrv_reopen(base
, orig_base_flags
, NULL
);