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_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 secondary_do_checkpoint(BlockDriverState
*bs
, Error
**errp
)
312 BDRVReplicationState
*s
= bs
->opaque
;
313 BdrvChild
*active_disk
= bs
->file
;
314 Error
*local_err
= NULL
;
317 if (!s
->backup_job
) {
318 error_setg(errp
, "Backup job was cancelled unexpectedly");
322 backup_do_checkpoint(s
->backup_job
, &local_err
);
324 error_propagate(errp
, local_err
);
328 if (!active_disk
->bs
->drv
) {
329 error_setg(errp
, "Active disk %s is ejected",
330 active_disk
->bs
->node_name
);
334 ret
= bdrv_make_empty(active_disk
, errp
);
339 if (!s
->hidden_disk
->bs
->drv
) {
340 error_setg(errp
, "Hidden disk %s is ejected",
341 s
->hidden_disk
->bs
->node_name
);
345 ret
= bdrv_make_empty(s
->hidden_disk
, errp
);
351 /* This function is supposed to be called twice:
352 * first with writable = true, then with writable = false.
353 * The first call puts s->hidden_disk and s->secondary_disk in
354 * r/w mode, and the second puts them back in their original state.
356 static void reopen_backing_file(BlockDriverState
*bs
, bool writable
,
359 BDRVReplicationState
*s
= bs
->opaque
;
360 BdrvChild
*hidden_disk
, *secondary_disk
;
361 BlockReopenQueue
*reopen_queue
= NULL
;
364 * s->hidden_disk and s->secondary_disk may not be set yet, as they will
365 * only be set after the children are writable.
367 hidden_disk
= bs
->file
->bs
->backing
;
368 secondary_disk
= hidden_disk
->bs
->backing
;
371 s
->orig_hidden_read_only
= bdrv_is_read_only(hidden_disk
->bs
);
372 s
->orig_secondary_read_only
= bdrv_is_read_only(secondary_disk
->bs
);
375 if (s
->orig_hidden_read_only
) {
376 QDict
*opts
= qdict_new();
377 qdict_put_bool(opts
, BDRV_OPT_READ_ONLY
, !writable
);
378 reopen_queue
= bdrv_reopen_queue(reopen_queue
, hidden_disk
->bs
,
382 if (s
->orig_secondary_read_only
) {
383 QDict
*opts
= qdict_new();
384 qdict_put_bool(opts
, BDRV_OPT_READ_ONLY
, !writable
);
385 reopen_queue
= bdrv_reopen_queue(reopen_queue
, secondary_disk
->bs
,
390 AioContext
*ctx
= bdrv_get_aio_context(bs
);
391 if (ctx
!= qemu_get_aio_context()) {
392 aio_context_release(ctx
);
394 bdrv_reopen_multiple(reopen_queue
, errp
);
395 if (ctx
!= qemu_get_aio_context()) {
396 aio_context_acquire(ctx
);
401 static void backup_job_cleanup(BlockDriverState
*bs
)
403 BDRVReplicationState
*s
= bs
->opaque
;
404 BlockDriverState
*top_bs
;
406 s
->backup_job
= NULL
;
408 top_bs
= bdrv_lookup_bs(s
->top_id
, s
->top_id
, NULL
);
412 bdrv_op_unblock_all(top_bs
, s
->blocker
);
413 error_free(s
->blocker
);
414 reopen_backing_file(bs
, false, NULL
);
417 static void backup_job_completed(void *opaque
, int ret
)
419 BlockDriverState
*bs
= opaque
;
420 BDRVReplicationState
*s
= bs
->opaque
;
422 if (s
->stage
!= BLOCK_REPLICATION_FAILOVER
) {
423 /* The backup job is cancelled unexpectedly */
427 backup_job_cleanup(bs
);
430 static bool check_top_bs(BlockDriverState
*top_bs
, BlockDriverState
*bs
)
434 /* The bs itself is the top_bs */
439 /* Iterate over top_bs's children */
440 QLIST_FOREACH(child
, &top_bs
->children
, next
) {
441 if (child
->bs
== bs
|| check_top_bs(child
->bs
, bs
)) {
449 static void replication_start(ReplicationState
*rs
, ReplicationMode mode
,
452 BlockDriverState
*bs
= rs
->opaque
;
453 BDRVReplicationState
*s
;
454 BlockDriverState
*top_bs
;
455 BdrvChild
*active_disk
, *hidden_disk
, *secondary_disk
;
456 int64_t active_length
, hidden_length
, disk_length
;
457 AioContext
*aio_context
;
458 Error
*local_err
= NULL
;
459 BackupPerf perf
= { .use_copy_range
= true, .max_workers
= 1 };
461 aio_context
= bdrv_get_aio_context(bs
);
462 aio_context_acquire(aio_context
);
465 if (s
->stage
== BLOCK_REPLICATION_DONE
||
466 s
->stage
== BLOCK_REPLICATION_FAILOVER
) {
468 * This case happens when a secondary is promoted to primary.
469 * Ignore the request because the secondary side of replication
470 * doesn't have to do anything anymore.
472 aio_context_release(aio_context
);
476 if (s
->stage
!= BLOCK_REPLICATION_NONE
) {
477 error_setg(errp
, "Block replication is running or done");
478 aio_context_release(aio_context
);
482 if (s
->mode
!= mode
) {
483 error_setg(errp
, "The parameter mode's value is invalid, needs %d,"
484 " but got %d", s
->mode
, mode
);
485 aio_context_release(aio_context
);
490 case REPLICATION_MODE_PRIMARY
:
492 case REPLICATION_MODE_SECONDARY
:
493 active_disk
= bs
->file
;
494 if (!active_disk
|| !active_disk
->bs
|| !active_disk
->bs
->backing
) {
495 error_setg(errp
, "Active disk doesn't have backing file");
496 aio_context_release(aio_context
);
500 hidden_disk
= active_disk
->bs
->backing
;
501 if (!hidden_disk
->bs
|| !hidden_disk
->bs
->backing
) {
502 error_setg(errp
, "Hidden disk doesn't have backing file");
503 aio_context_release(aio_context
);
507 secondary_disk
= hidden_disk
->bs
->backing
;
508 if (!secondary_disk
->bs
|| !bdrv_has_blk(secondary_disk
->bs
)) {
509 error_setg(errp
, "The secondary disk doesn't have block backend");
510 aio_context_release(aio_context
);
514 /* verify the length */
515 active_length
= bdrv_getlength(active_disk
->bs
);
516 hidden_length
= bdrv_getlength(hidden_disk
->bs
);
517 disk_length
= bdrv_getlength(secondary_disk
->bs
);
518 if (active_length
< 0 || hidden_length
< 0 || disk_length
< 0 ||
519 active_length
!= hidden_length
|| hidden_length
!= disk_length
) {
520 error_setg(errp
, "Active disk, hidden disk, secondary disk's length"
521 " are not the same");
522 aio_context_release(aio_context
);
526 /* Must be true, or the bdrv_getlength() calls would have failed */
527 assert(active_disk
->bs
->drv
&& hidden_disk
->bs
->drv
);
529 if (!active_disk
->bs
->drv
->bdrv_make_empty
||
530 !hidden_disk
->bs
->drv
->bdrv_make_empty
) {
532 "Active disk or hidden disk doesn't support make_empty");
533 aio_context_release(aio_context
);
537 /* reopen the backing file in r/w mode */
538 reopen_backing_file(bs
, true, &local_err
);
540 error_propagate(errp
, local_err
);
541 aio_context_release(aio_context
);
545 bdrv_graph_wrlock(bs
);
547 bdrv_ref(hidden_disk
->bs
);
548 s
->hidden_disk
= bdrv_attach_child(bs
, hidden_disk
->bs
, "hidden disk",
549 &child_of_bds
, BDRV_CHILD_DATA
,
552 error_propagate(errp
, local_err
);
553 bdrv_graph_wrunlock();
554 aio_context_release(aio_context
);
558 bdrv_ref(secondary_disk
->bs
);
559 s
->secondary_disk
= bdrv_attach_child(bs
, secondary_disk
->bs
,
560 "secondary disk", &child_of_bds
,
561 BDRV_CHILD_DATA
, &local_err
);
563 error_propagate(errp
, local_err
);
564 bdrv_graph_wrunlock();
565 aio_context_release(aio_context
);
569 bdrv_graph_wrunlock();
571 /* start backup job now */
572 error_setg(&s
->blocker
,
573 "Block device is in use by internal backup job");
575 top_bs
= bdrv_lookup_bs(s
->top_id
, s
->top_id
, NULL
);
576 if (!top_bs
|| !bdrv_is_root_node(top_bs
) ||
577 !check_top_bs(top_bs
, bs
)) {
578 error_setg(errp
, "No top_bs or it is invalid");
579 reopen_backing_file(bs
, false, NULL
);
580 aio_context_release(aio_context
);
583 bdrv_op_block_all(top_bs
, s
->blocker
);
584 bdrv_op_unblock(top_bs
, BLOCK_OP_TYPE_DATAPLANE
, s
->blocker
);
586 s
->backup_job
= backup_job_create(
587 NULL
, s
->secondary_disk
->bs
, s
->hidden_disk
->bs
,
588 0, MIRROR_SYNC_MODE_NONE
, NULL
, 0, false, NULL
,
590 BLOCKDEV_ON_ERROR_REPORT
,
591 BLOCKDEV_ON_ERROR_REPORT
, JOB_INTERNAL
,
592 backup_job_completed
, bs
, NULL
, &local_err
);
594 error_propagate(errp
, local_err
);
595 backup_job_cleanup(bs
);
596 aio_context_release(aio_context
);
599 job_start(&s
->backup_job
->job
);
602 aio_context_release(aio_context
);
606 s
->stage
= BLOCK_REPLICATION_RUNNING
;
608 if (s
->mode
== REPLICATION_MODE_SECONDARY
) {
609 secondary_do_checkpoint(bs
, errp
);
613 aio_context_release(aio_context
);
616 static void replication_do_checkpoint(ReplicationState
*rs
, Error
**errp
)
618 BlockDriverState
*bs
= rs
->opaque
;
619 BDRVReplicationState
*s
;
620 AioContext
*aio_context
;
622 aio_context
= bdrv_get_aio_context(bs
);
623 aio_context_acquire(aio_context
);
626 if (s
->stage
== BLOCK_REPLICATION_DONE
||
627 s
->stage
== BLOCK_REPLICATION_FAILOVER
) {
629 * This case happens when a secondary was promoted to primary.
630 * Ignore the request because the secondary side of replication
631 * doesn't have to do anything anymore.
633 aio_context_release(aio_context
);
637 if (s
->mode
== REPLICATION_MODE_SECONDARY
) {
638 secondary_do_checkpoint(bs
, errp
);
640 aio_context_release(aio_context
);
643 static void replication_get_error(ReplicationState
*rs
, Error
**errp
)
645 BlockDriverState
*bs
= rs
->opaque
;
646 BDRVReplicationState
*s
;
647 AioContext
*aio_context
;
649 aio_context
= bdrv_get_aio_context(bs
);
650 aio_context_acquire(aio_context
);
653 if (s
->stage
== BLOCK_REPLICATION_NONE
) {
654 error_setg(errp
, "Block replication is not running");
655 aio_context_release(aio_context
);
660 error_setg(errp
, "I/O error occurred");
661 aio_context_release(aio_context
);
664 aio_context_release(aio_context
);
667 static void replication_done(void *opaque
, int ret
)
669 BlockDriverState
*bs
= opaque
;
670 BDRVReplicationState
*s
= bs
->opaque
;
673 s
->stage
= BLOCK_REPLICATION_DONE
;
675 bdrv_graph_wrlock(NULL
);
676 bdrv_unref_child(bs
, s
->secondary_disk
);
677 s
->secondary_disk
= NULL
;
678 bdrv_unref_child(bs
, s
->hidden_disk
);
679 s
->hidden_disk
= NULL
;
680 bdrv_graph_wrunlock();
684 s
->stage
= BLOCK_REPLICATION_FAILOVER_FAILED
;
689 static void replication_stop(ReplicationState
*rs
, bool failover
, Error
**errp
)
691 BlockDriverState
*bs
= rs
->opaque
;
692 BDRVReplicationState
*s
;
693 AioContext
*aio_context
;
695 aio_context
= bdrv_get_aio_context(bs
);
696 aio_context_acquire(aio_context
);
699 if (s
->stage
== BLOCK_REPLICATION_DONE
||
700 s
->stage
== BLOCK_REPLICATION_FAILOVER
) {
702 * This case happens when a secondary was promoted to primary.
703 * Ignore the request because the secondary side of replication
704 * doesn't have to do anything anymore.
706 aio_context_release(aio_context
);
710 if (s
->stage
!= BLOCK_REPLICATION_RUNNING
) {
711 error_setg(errp
, "Block replication is not running");
712 aio_context_release(aio_context
);
717 case REPLICATION_MODE_PRIMARY
:
718 s
->stage
= BLOCK_REPLICATION_DONE
;
721 case REPLICATION_MODE_SECONDARY
:
723 * This BDS will be closed, and the job should be completed
724 * before the BDS is closed, because we will access hidden
725 * disk, secondary disk in backup_job_completed().
728 aio_context_release(aio_context
);
729 job_cancel_sync(&s
->backup_job
->job
, true);
730 aio_context_acquire(aio_context
);
734 secondary_do_checkpoint(bs
, errp
);
735 s
->stage
= BLOCK_REPLICATION_DONE
;
736 aio_context_release(aio_context
);
740 s
->stage
= BLOCK_REPLICATION_FAILOVER
;
741 s
->commit_job
= commit_active_start(
742 NULL
, bs
->file
->bs
, s
->secondary_disk
->bs
,
743 JOB_INTERNAL
, 0, BLOCKDEV_ON_ERROR_REPORT
,
744 NULL
, replication_done
, bs
, true, errp
);
747 aio_context_release(aio_context
);
750 aio_context_release(aio_context
);
753 static const char *const replication_strong_runtime_opts
[] = {
760 static BlockDriver bdrv_replication
= {
761 .format_name
= "replication",
762 .instance_size
= sizeof(BDRVReplicationState
),
764 .bdrv_open
= replication_open
,
765 .bdrv_close
= replication_close
,
766 .bdrv_child_perm
= replication_child_perm
,
768 .bdrv_co_getlength
= replication_co_getlength
,
769 .bdrv_co_readv
= replication_co_readv
,
770 .bdrv_co_writev
= replication_co_writev
,
774 .strong_runtime_opts
= replication_strong_runtime_opts
,
777 static void bdrv_replication_init(void)
779 bdrv_register(&bdrv_replication
);
782 block_init(bdrv_replication_init
);