2 * Replication Block filter
4 * Copyright (c) 2016 HUAWEI TECHNOLOGIES CO., LTD.
5 * Copyright (c) 2016 Intel Corporation
6 * Copyright (c) 2016 FUJITSU LIMITED
9 * Wen Congyang <wency@cn.fujitsu.com>
11 * This work is licensed under the terms of the GNU GPL, version 2 or later.
12 * See the COPYING file in the top-level directory.
15 #include "qemu/osdep.h"
16 #include "qemu/module.h"
17 #include "qemu/option.h"
18 #include "block/nbd.h"
19 #include "block/blockjob.h"
20 #include "block/block_int.h"
21 #include "block/block_backup.h"
22 #include "sysemu/block-backend.h"
23 #include "qapi/error.h"
24 #include "qapi/qmp/qdict.h"
25 #include "block/replication.h"
28 BLOCK_REPLICATION_NONE
, /* block replication is not started */
29 BLOCK_REPLICATION_RUNNING
, /* block replication is running */
30 BLOCK_REPLICATION_FAILOVER
, /* failover is running in background */
31 BLOCK_REPLICATION_FAILOVER_FAILED
, /* failover failed */
32 BLOCK_REPLICATION_DONE
, /* block replication is done */
35 typedef struct BDRVReplicationState
{
37 ReplicationStage stage
;
39 BdrvChild
*hidden_disk
;
40 BdrvChild
*secondary_disk
;
45 bool orig_hidden_read_only
;
46 bool orig_secondary_read_only
;
48 } BDRVReplicationState
;
50 static void replication_start(ReplicationState
*rs
, ReplicationMode mode
,
52 static void replication_do_checkpoint(ReplicationState
*rs
, Error
**errp
);
53 static void replication_get_error(ReplicationState
*rs
, Error
**errp
);
54 static void replication_stop(ReplicationState
*rs
, bool failover
,
57 #define REPLICATION_MODE "mode"
58 #define REPLICATION_TOP_ID "top-id"
59 static QemuOptsList replication_runtime_opts
= {
60 .name
= "replication",
61 .head
= QTAILQ_HEAD_INITIALIZER(replication_runtime_opts
.head
),
64 .name
= REPLICATION_MODE
,
65 .type
= QEMU_OPT_STRING
,
68 .name
= REPLICATION_TOP_ID
,
69 .type
= QEMU_OPT_STRING
,
75 static ReplicationOps replication_ops
= {
76 .start
= replication_start
,
77 .checkpoint
= replication_do_checkpoint
,
78 .get_error
= replication_get_error
,
79 .stop
= replication_stop
,
82 static int replication_open(BlockDriverState
*bs
, QDict
*options
,
83 int flags
, Error
**errp
)
86 BDRVReplicationState
*s
= bs
->opaque
;
87 QemuOpts
*opts
= NULL
;
91 ret
= bdrv_open_file_child(NULL
, options
, "file", bs
, errp
);
97 opts
= qemu_opts_create(&replication_runtime_opts
, NULL
, 0, &error_abort
);
98 if (!qemu_opts_absorb_qdict(opts
, options
, errp
)) {
102 mode
= qemu_opt_get(opts
, REPLICATION_MODE
);
104 error_setg(errp
, "Missing the option mode");
108 if (!strcmp(mode
, "primary")) {
109 s
->mode
= REPLICATION_MODE_PRIMARY
;
110 top_id
= qemu_opt_get(opts
, REPLICATION_TOP_ID
);
113 "The primary side does not support option top-id");
116 } else if (!strcmp(mode
, "secondary")) {
117 s
->mode
= REPLICATION_MODE_SECONDARY
;
118 top_id
= qemu_opt_get(opts
, REPLICATION_TOP_ID
);
119 s
->top_id
= g_strdup(top_id
);
121 error_setg(errp
, "Missing the option top-id");
126 "The option mode's value should be primary or secondary");
130 s
->rs
= replication_new(bs
, &replication_ops
);
139 static void replication_close(BlockDriverState
*bs
)
141 BDRVReplicationState
*s
= bs
->opaque
;
145 if (s
->stage
== BLOCK_REPLICATION_RUNNING
) {
146 replication_stop(s
->rs
, false, NULL
);
148 if (s
->stage
== BLOCK_REPLICATION_FAILOVER
) {
149 commit_job
= &s
->commit_job
->job
;
150 assert(commit_job
->aio_context
== qemu_get_current_aio_context());
151 job_cancel_sync(commit_job
, false);
154 if (s
->mode
== REPLICATION_MODE_SECONDARY
) {
158 replication_remove(s
->rs
);
161 static void replication_child_perm(BlockDriverState
*bs
, BdrvChild
*c
,
163 BlockReopenQueue
*reopen_queue
,
164 uint64_t perm
, uint64_t shared
,
165 uint64_t *nperm
, uint64_t *nshared
)
167 if (role
& BDRV_CHILD_PRIMARY
) {
168 *nperm
= BLK_PERM_CONSISTENT_READ
;
173 if ((bs
->open_flags
& (BDRV_O_INACTIVE
| BDRV_O_RDWR
)) == BDRV_O_RDWR
) {
174 *nperm
|= BLK_PERM_WRITE
;
176 *nshared
= BLK_PERM_CONSISTENT_READ
178 | BLK_PERM_WRITE_UNCHANGED
;
182 static int64_t coroutine_fn GRAPH_RDLOCK
183 replication_co_getlength(BlockDriverState
*bs
)
185 return bdrv_co_getlength(bs
->file
->bs
);
188 static int replication_get_io_status(BDRVReplicationState
*s
)
191 case BLOCK_REPLICATION_NONE
:
193 case BLOCK_REPLICATION_RUNNING
:
195 case BLOCK_REPLICATION_FAILOVER
:
196 return s
->mode
== REPLICATION_MODE_PRIMARY
? -EIO
: 0;
197 case BLOCK_REPLICATION_FAILOVER_FAILED
:
198 return s
->mode
== REPLICATION_MODE_PRIMARY
? -EIO
: 1;
199 case BLOCK_REPLICATION_DONE
:
201 * active commit job completes, and active disk and secondary_disk
202 * is swapped, so we can operate bs->file directly
204 return s
->mode
== REPLICATION_MODE_PRIMARY
? -EIO
: 0;
210 static int replication_return_value(BDRVReplicationState
*s
, int ret
)
212 if (s
->mode
== REPLICATION_MODE_SECONDARY
) {
224 static int coroutine_fn GRAPH_RDLOCK
225 replication_co_readv(BlockDriverState
*bs
, int64_t sector_num
,
226 int remaining_sectors
, QEMUIOVector
*qiov
)
228 BDRVReplicationState
*s
= bs
->opaque
;
231 if (s
->mode
== REPLICATION_MODE_PRIMARY
) {
232 /* We only use it to forward primary write requests */
236 ret
= replication_get_io_status(s
);
241 ret
= bdrv_co_preadv(bs
->file
, sector_num
* BDRV_SECTOR_SIZE
,
242 remaining_sectors
* BDRV_SECTOR_SIZE
, qiov
, 0);
244 return replication_return_value(s
, ret
);
247 static int coroutine_fn GRAPH_RDLOCK
248 replication_co_writev(BlockDriverState
*bs
, int64_t sector_num
,
249 int remaining_sectors
, QEMUIOVector
*qiov
, int flags
)
251 BDRVReplicationState
*s
= bs
->opaque
;
252 QEMUIOVector hd_qiov
;
253 uint64_t bytes_done
= 0;
254 BdrvChild
*top
= bs
->file
;
255 BdrvChild
*base
= s
->secondary_disk
;
260 ret
= replication_get_io_status(s
);
266 ret
= bdrv_co_pwritev(top
, sector_num
* BDRV_SECTOR_SIZE
,
267 remaining_sectors
* BDRV_SECTOR_SIZE
, qiov
, 0);
268 return replication_return_value(s
, ret
);
272 * Failover failed, only write to active disk if the sectors
273 * have already been allocated in active disk/hidden disk.
275 qemu_iovec_init(&hd_qiov
, qiov
->niov
);
276 while (remaining_sectors
> 0) {
279 ret
= bdrv_co_is_allocated_above(top
->bs
, base
->bs
, false,
280 sector_num
* BDRV_SECTOR_SIZE
,
281 remaining_sectors
* BDRV_SECTOR_SIZE
,
287 assert(QEMU_IS_ALIGNED(count
, BDRV_SECTOR_SIZE
));
288 n
= count
>> BDRV_SECTOR_BITS
;
289 qemu_iovec_reset(&hd_qiov
);
290 qemu_iovec_concat(&hd_qiov
, qiov
, bytes_done
, count
);
292 target
= ret
? top
: base
;
293 ret
= bdrv_co_pwritev(target
, sector_num
* BDRV_SECTOR_SIZE
,
294 n
* BDRV_SECTOR_SIZE
, &hd_qiov
, 0);
299 remaining_sectors
-= n
;
305 qemu_iovec_destroy(&hd_qiov
);
310 static void GRAPH_UNLOCKED
311 secondary_do_checkpoint(BlockDriverState
*bs
, Error
**errp
)
313 BDRVReplicationState
*s
= bs
->opaque
;
314 BdrvChild
*active_disk
= bs
->file
;
315 Error
*local_err
= NULL
;
318 GRAPH_RDLOCK_GUARD_MAINLOOP();
320 if (!s
->backup_job
) {
321 error_setg(errp
, "Backup job was cancelled unexpectedly");
325 backup_do_checkpoint(s
->backup_job
, &local_err
);
327 error_propagate(errp
, local_err
);
331 if (!active_disk
->bs
->drv
) {
332 error_setg(errp
, "Active disk %s is ejected",
333 active_disk
->bs
->node_name
);
337 ret
= bdrv_make_empty(active_disk
, errp
);
342 if (!s
->hidden_disk
->bs
->drv
) {
343 error_setg(errp
, "Hidden disk %s is ejected",
344 s
->hidden_disk
->bs
->node_name
);
348 ret
= bdrv_make_empty(s
->hidden_disk
, errp
);
354 /* This function is supposed to be called twice:
355 * first with writable = true, then with writable = false.
356 * The first call puts s->hidden_disk and s->secondary_disk in
357 * r/w mode, and the second puts them back in their original state.
359 static void reopen_backing_file(BlockDriverState
*bs
, bool writable
,
362 BDRVReplicationState
*s
= bs
->opaque
;
363 BdrvChild
*hidden_disk
, *secondary_disk
;
364 BlockReopenQueue
*reopen_queue
= NULL
;
367 * s->hidden_disk and s->secondary_disk may not be set yet, as they will
368 * only be set after the children are writable.
370 hidden_disk
= bs
->file
->bs
->backing
;
371 secondary_disk
= hidden_disk
->bs
->backing
;
374 s
->orig_hidden_read_only
= bdrv_is_read_only(hidden_disk
->bs
);
375 s
->orig_secondary_read_only
= bdrv_is_read_only(secondary_disk
->bs
);
378 if (s
->orig_hidden_read_only
) {
379 QDict
*opts
= qdict_new();
380 qdict_put_bool(opts
, BDRV_OPT_READ_ONLY
, !writable
);
381 reopen_queue
= bdrv_reopen_queue(reopen_queue
, hidden_disk
->bs
,
385 if (s
->orig_secondary_read_only
) {
386 QDict
*opts
= qdict_new();
387 qdict_put_bool(opts
, BDRV_OPT_READ_ONLY
, !writable
);
388 reopen_queue
= bdrv_reopen_queue(reopen_queue
, secondary_disk
->bs
,
393 AioContext
*ctx
= bdrv_get_aio_context(bs
);
394 if (ctx
!= qemu_get_aio_context()) {
395 aio_context_release(ctx
);
397 bdrv_reopen_multiple(reopen_queue
, errp
);
398 if (ctx
!= qemu_get_aio_context()) {
399 aio_context_acquire(ctx
);
404 static void backup_job_cleanup(BlockDriverState
*bs
)
406 BDRVReplicationState
*s
= bs
->opaque
;
407 BlockDriverState
*top_bs
;
409 s
->backup_job
= NULL
;
411 top_bs
= bdrv_lookup_bs(s
->top_id
, s
->top_id
, NULL
);
415 bdrv_op_unblock_all(top_bs
, s
->blocker
);
416 error_free(s
->blocker
);
417 reopen_backing_file(bs
, false, NULL
);
420 static void backup_job_completed(void *opaque
, int ret
)
422 BlockDriverState
*bs
= opaque
;
423 BDRVReplicationState
*s
= bs
->opaque
;
425 if (s
->stage
!= BLOCK_REPLICATION_FAILOVER
) {
426 /* The backup job is cancelled unexpectedly */
430 backup_job_cleanup(bs
);
433 static bool GRAPH_RDLOCK
434 check_top_bs(BlockDriverState
*top_bs
, BlockDriverState
*bs
)
438 /* The bs itself is the top_bs */
443 /* Iterate over top_bs's children */
444 QLIST_FOREACH(child
, &top_bs
->children
, next
) {
445 if (child
->bs
== bs
|| check_top_bs(child
->bs
, bs
)) {
453 static void replication_start(ReplicationState
*rs
, ReplicationMode mode
,
456 BlockDriverState
*bs
= rs
->opaque
;
457 BDRVReplicationState
*s
;
458 BlockDriverState
*top_bs
;
459 BdrvChild
*active_disk
, *hidden_disk
, *secondary_disk
;
460 int64_t active_length
, hidden_length
, disk_length
;
461 AioContext
*aio_context
;
462 Error
*local_err
= NULL
;
463 BackupPerf perf
= { .use_copy_range
= true, .max_workers
= 1 };
467 aio_context
= bdrv_get_aio_context(bs
);
468 aio_context_acquire(aio_context
);
471 if (s
->stage
== BLOCK_REPLICATION_DONE
||
472 s
->stage
== BLOCK_REPLICATION_FAILOVER
) {
474 * This case happens when a secondary is promoted to primary.
475 * Ignore the request because the secondary side of replication
476 * doesn't have to do anything anymore.
478 aio_context_release(aio_context
);
482 if (s
->stage
!= BLOCK_REPLICATION_NONE
) {
483 error_setg(errp
, "Block replication is running or done");
484 aio_context_release(aio_context
);
488 if (s
->mode
!= mode
) {
489 error_setg(errp
, "The parameter mode's value is invalid, needs %d,"
490 " but got %d", s
->mode
, mode
);
491 aio_context_release(aio_context
);
496 case REPLICATION_MODE_PRIMARY
:
498 case REPLICATION_MODE_SECONDARY
:
499 active_disk
= bs
->file
;
500 if (!active_disk
|| !active_disk
->bs
|| !active_disk
->bs
->backing
) {
501 error_setg(errp
, "Active disk doesn't have backing file");
502 aio_context_release(aio_context
);
506 hidden_disk
= active_disk
->bs
->backing
;
507 if (!hidden_disk
->bs
|| !hidden_disk
->bs
->backing
) {
508 error_setg(errp
, "Hidden disk doesn't have backing file");
509 aio_context_release(aio_context
);
513 bdrv_graph_rdlock_main_loop();
514 secondary_disk
= hidden_disk
->bs
->backing
;
515 if (!secondary_disk
->bs
|| !bdrv_has_blk(secondary_disk
->bs
)) {
516 error_setg(errp
, "The secondary disk doesn't have block backend");
517 bdrv_graph_rdunlock_main_loop();
518 aio_context_release(aio_context
);
521 bdrv_graph_rdunlock_main_loop();
523 /* verify the length */
524 active_length
= bdrv_getlength(active_disk
->bs
);
525 hidden_length
= bdrv_getlength(hidden_disk
->bs
);
526 disk_length
= bdrv_getlength(secondary_disk
->bs
);
527 if (active_length
< 0 || hidden_length
< 0 || disk_length
< 0 ||
528 active_length
!= hidden_length
|| hidden_length
!= disk_length
) {
529 error_setg(errp
, "Active disk, hidden disk, secondary disk's length"
530 " are not the same");
531 aio_context_release(aio_context
);
535 /* Must be true, or the bdrv_getlength() calls would have failed */
536 assert(active_disk
->bs
->drv
&& hidden_disk
->bs
->drv
);
538 bdrv_graph_rdlock_main_loop();
539 if (!active_disk
->bs
->drv
->bdrv_make_empty
||
540 !hidden_disk
->bs
->drv
->bdrv_make_empty
) {
542 "Active disk or hidden disk doesn't support make_empty");
543 aio_context_release(aio_context
);
544 bdrv_graph_rdunlock_main_loop();
547 bdrv_graph_rdunlock_main_loop();
549 /* reopen the backing file in r/w mode */
550 reopen_backing_file(bs
, true, &local_err
);
552 error_propagate(errp
, local_err
);
553 aio_context_release(aio_context
);
557 bdrv_graph_wrlock(bs
);
559 bdrv_ref(hidden_disk
->bs
);
560 s
->hidden_disk
= bdrv_attach_child(bs
, hidden_disk
->bs
, "hidden disk",
561 &child_of_bds
, BDRV_CHILD_DATA
,
564 error_propagate(errp
, local_err
);
565 bdrv_graph_wrunlock();
566 aio_context_release(aio_context
);
570 bdrv_ref(secondary_disk
->bs
);
571 s
->secondary_disk
= bdrv_attach_child(bs
, secondary_disk
->bs
,
572 "secondary disk", &child_of_bds
,
573 BDRV_CHILD_DATA
, &local_err
);
575 error_propagate(errp
, local_err
);
576 bdrv_graph_wrunlock();
577 aio_context_release(aio_context
);
581 /* start backup job now */
582 error_setg(&s
->blocker
,
583 "Block device is in use by internal backup job");
585 top_bs
= bdrv_lookup_bs(s
->top_id
, s
->top_id
, NULL
);
586 if (!top_bs
|| !bdrv_is_root_node(top_bs
) ||
587 !check_top_bs(top_bs
, bs
)) {
588 error_setg(errp
, "No top_bs or it is invalid");
589 bdrv_graph_wrunlock();
590 reopen_backing_file(bs
, false, NULL
);
591 aio_context_release(aio_context
);
594 bdrv_op_block_all(top_bs
, s
->blocker
);
595 bdrv_op_unblock(top_bs
, BLOCK_OP_TYPE_DATAPLANE
, s
->blocker
);
597 bdrv_graph_wrunlock();
599 s
->backup_job
= backup_job_create(
600 NULL
, s
->secondary_disk
->bs
, s
->hidden_disk
->bs
,
601 0, MIRROR_SYNC_MODE_NONE
, NULL
, 0, false, NULL
,
603 BLOCKDEV_ON_ERROR_REPORT
,
604 BLOCKDEV_ON_ERROR_REPORT
, JOB_INTERNAL
,
605 backup_job_completed
, bs
, NULL
, &local_err
);
607 error_propagate(errp
, local_err
);
608 backup_job_cleanup(bs
);
609 aio_context_release(aio_context
);
612 job_start(&s
->backup_job
->job
);
615 aio_context_release(aio_context
);
619 s
->stage
= BLOCK_REPLICATION_RUNNING
;
621 if (s
->mode
== REPLICATION_MODE_SECONDARY
) {
622 secondary_do_checkpoint(bs
, errp
);
626 aio_context_release(aio_context
);
629 static void replication_do_checkpoint(ReplicationState
*rs
, Error
**errp
)
631 BlockDriverState
*bs
= rs
->opaque
;
632 BDRVReplicationState
*s
;
633 AioContext
*aio_context
;
635 aio_context
= bdrv_get_aio_context(bs
);
636 aio_context_acquire(aio_context
);
639 if (s
->stage
== BLOCK_REPLICATION_DONE
||
640 s
->stage
== BLOCK_REPLICATION_FAILOVER
) {
642 * This case happens when a secondary was promoted to primary.
643 * Ignore the request because the secondary side of replication
644 * doesn't have to do anything anymore.
646 aio_context_release(aio_context
);
650 if (s
->mode
== REPLICATION_MODE_SECONDARY
) {
651 secondary_do_checkpoint(bs
, errp
);
653 aio_context_release(aio_context
);
656 static void replication_get_error(ReplicationState
*rs
, Error
**errp
)
658 BlockDriverState
*bs
= rs
->opaque
;
659 BDRVReplicationState
*s
;
660 AioContext
*aio_context
;
662 aio_context
= bdrv_get_aio_context(bs
);
663 aio_context_acquire(aio_context
);
666 if (s
->stage
== BLOCK_REPLICATION_NONE
) {
667 error_setg(errp
, "Block replication is not running");
668 aio_context_release(aio_context
);
673 error_setg(errp
, "I/O error occurred");
674 aio_context_release(aio_context
);
677 aio_context_release(aio_context
);
680 static void replication_done(void *opaque
, int ret
)
682 BlockDriverState
*bs
= opaque
;
683 BDRVReplicationState
*s
= bs
->opaque
;
686 s
->stage
= BLOCK_REPLICATION_DONE
;
688 bdrv_graph_wrlock(NULL
);
689 bdrv_unref_child(bs
, s
->secondary_disk
);
690 s
->secondary_disk
= NULL
;
691 bdrv_unref_child(bs
, s
->hidden_disk
);
692 s
->hidden_disk
= NULL
;
693 bdrv_graph_wrunlock();
697 s
->stage
= BLOCK_REPLICATION_FAILOVER_FAILED
;
702 static void replication_stop(ReplicationState
*rs
, bool failover
, Error
**errp
)
704 BlockDriverState
*bs
= rs
->opaque
;
705 BDRVReplicationState
*s
;
706 AioContext
*aio_context
;
708 aio_context
= bdrv_get_aio_context(bs
);
709 aio_context_acquire(aio_context
);
712 if (s
->stage
== BLOCK_REPLICATION_DONE
||
713 s
->stage
== BLOCK_REPLICATION_FAILOVER
) {
715 * This case happens when a secondary was promoted to primary.
716 * Ignore the request because the secondary side of replication
717 * doesn't have to do anything anymore.
719 aio_context_release(aio_context
);
723 if (s
->stage
!= BLOCK_REPLICATION_RUNNING
) {
724 error_setg(errp
, "Block replication is not running");
725 aio_context_release(aio_context
);
730 case REPLICATION_MODE_PRIMARY
:
731 s
->stage
= BLOCK_REPLICATION_DONE
;
734 case REPLICATION_MODE_SECONDARY
:
736 * This BDS will be closed, and the job should be completed
737 * before the BDS is closed, because we will access hidden
738 * disk, secondary disk in backup_job_completed().
741 aio_context_release(aio_context
);
742 job_cancel_sync(&s
->backup_job
->job
, true);
743 aio_context_acquire(aio_context
);
747 secondary_do_checkpoint(bs
, errp
);
748 s
->stage
= BLOCK_REPLICATION_DONE
;
749 aio_context_release(aio_context
);
753 s
->stage
= BLOCK_REPLICATION_FAILOVER
;
754 s
->commit_job
= commit_active_start(
755 NULL
, bs
->file
->bs
, s
->secondary_disk
->bs
,
756 JOB_INTERNAL
, 0, BLOCKDEV_ON_ERROR_REPORT
,
757 NULL
, replication_done
, bs
, true, errp
);
760 aio_context_release(aio_context
);
763 aio_context_release(aio_context
);
766 static const char *const replication_strong_runtime_opts
[] = {
773 static BlockDriver bdrv_replication
= {
774 .format_name
= "replication",
775 .instance_size
= sizeof(BDRVReplicationState
),
777 .bdrv_open
= replication_open
,
778 .bdrv_close
= replication_close
,
779 .bdrv_child_perm
= replication_child_perm
,
781 .bdrv_co_getlength
= replication_co_getlength
,
782 .bdrv_co_readv
= replication_co_readv
,
783 .bdrv_co_writev
= replication_co_writev
,
787 .strong_runtime_opts
= replication_strong_runtime_opts
,
790 static void bdrv_replication_init(void)
792 bdrv_register(&bdrv_replication
);
795 block_init(bdrv_replication_init
);