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 "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
;
38 BdrvChild
*active_disk
;
40 BdrvChild
*hidden_disk
;
41 BdrvChild
*secondary_disk
;
46 bool orig_hidden_read_only
;
47 bool orig_secondary_read_only
;
49 } BDRVReplicationState
;
51 static void replication_start(ReplicationState
*rs
, ReplicationMode mode
,
53 static void replication_do_checkpoint(ReplicationState
*rs
, Error
**errp
);
54 static void replication_get_error(ReplicationState
*rs
, Error
**errp
);
55 static void replication_stop(ReplicationState
*rs
, bool failover
,
58 #define REPLICATION_MODE "mode"
59 #define REPLICATION_TOP_ID "top-id"
60 static QemuOptsList replication_runtime_opts
= {
61 .name
= "replication",
62 .head
= QTAILQ_HEAD_INITIALIZER(replication_runtime_opts
.head
),
65 .name
= REPLICATION_MODE
,
66 .type
= QEMU_OPT_STRING
,
69 .name
= REPLICATION_TOP_ID
,
70 .type
= QEMU_OPT_STRING
,
76 static ReplicationOps replication_ops
= {
77 .start
= replication_start
,
78 .checkpoint
= replication_do_checkpoint
,
79 .get_error
= replication_get_error
,
80 .stop
= replication_stop
,
83 static int replication_open(BlockDriverState
*bs
, QDict
*options
,
84 int flags
, Error
**errp
)
87 BDRVReplicationState
*s
= bs
->opaque
;
88 Error
*local_err
= NULL
;
89 QemuOpts
*opts
= NULL
;
93 bs
->file
= bdrv_open_child(NULL
, options
, "file", bs
, &child_file
,
100 opts
= qemu_opts_create(&replication_runtime_opts
, NULL
, 0, &error_abort
);
101 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
106 mode
= qemu_opt_get(opts
, REPLICATION_MODE
);
108 error_setg(&local_err
, "Missing the option mode");
112 if (!strcmp(mode
, "primary")) {
113 s
->mode
= REPLICATION_MODE_PRIMARY
;
114 top_id
= qemu_opt_get(opts
, REPLICATION_TOP_ID
);
116 error_setg(&local_err
, "The primary side does not support option top-id");
119 } else if (!strcmp(mode
, "secondary")) {
120 s
->mode
= REPLICATION_MODE_SECONDARY
;
121 top_id
= qemu_opt_get(opts
, REPLICATION_TOP_ID
);
122 s
->top_id
= g_strdup(top_id
);
124 error_setg(&local_err
, "Missing the option top-id");
128 error_setg(&local_err
,
129 "The option mode's value should be primary or secondary");
133 s
->rs
= replication_new(bs
, &replication_ops
);
139 error_propagate(errp
, local_err
);
144 static void replication_close(BlockDriverState
*bs
)
146 BDRVReplicationState
*s
= bs
->opaque
;
148 if (s
->stage
== BLOCK_REPLICATION_RUNNING
) {
149 replication_stop(s
->rs
, false, NULL
);
151 if (s
->stage
== BLOCK_REPLICATION_FAILOVER
) {
152 job_cancel_sync(&s
->commit_job
->job
);
155 if (s
->mode
== REPLICATION_MODE_SECONDARY
) {
159 replication_remove(s
->rs
);
162 static void replication_child_perm(BlockDriverState
*bs
, BdrvChild
*c
,
163 const BdrvChildRole
*role
,
164 BlockReopenQueue
*reopen_queue
,
165 uint64_t perm
, uint64_t shared
,
166 uint64_t *nperm
, uint64_t *nshared
)
168 *nperm
= BLK_PERM_CONSISTENT_READ
;
169 if ((bs
->open_flags
& (BDRV_O_INACTIVE
| BDRV_O_RDWR
)) == BDRV_O_RDWR
) {
170 *nperm
|= BLK_PERM_WRITE
;
172 *nshared
= BLK_PERM_CONSISTENT_READ \
174 | BLK_PERM_WRITE_UNCHANGED
;
178 static int64_t replication_getlength(BlockDriverState
*bs
)
180 return bdrv_getlength(bs
->file
->bs
);
183 static int replication_get_io_status(BDRVReplicationState
*s
)
186 case BLOCK_REPLICATION_NONE
:
188 case BLOCK_REPLICATION_RUNNING
:
190 case BLOCK_REPLICATION_FAILOVER
:
191 return s
->mode
== REPLICATION_MODE_PRIMARY
? -EIO
: 0;
192 case BLOCK_REPLICATION_FAILOVER_FAILED
:
193 return s
->mode
== REPLICATION_MODE_PRIMARY
? -EIO
: 1;
194 case BLOCK_REPLICATION_DONE
:
196 * active commit job completes, and active disk and secondary_disk
197 * is swapped, so we can operate bs->file directly
199 return s
->mode
== REPLICATION_MODE_PRIMARY
? -EIO
: 0;
205 static int replication_return_value(BDRVReplicationState
*s
, int ret
)
207 if (s
->mode
== REPLICATION_MODE_SECONDARY
) {
219 static coroutine_fn
int replication_co_readv(BlockDriverState
*bs
,
221 int remaining_sectors
,
224 BDRVReplicationState
*s
= bs
->opaque
;
227 if (s
->mode
== REPLICATION_MODE_PRIMARY
) {
228 /* We only use it to forward primary write requests */
232 ret
= replication_get_io_status(s
);
237 ret
= bdrv_co_preadv(bs
->file
, sector_num
* BDRV_SECTOR_SIZE
,
238 remaining_sectors
* BDRV_SECTOR_SIZE
, qiov
, 0);
240 return replication_return_value(s
, ret
);
243 static coroutine_fn
int replication_co_writev(BlockDriverState
*bs
,
245 int remaining_sectors
,
249 BDRVReplicationState
*s
= bs
->opaque
;
250 QEMUIOVector hd_qiov
;
251 uint64_t bytes_done
= 0;
252 BdrvChild
*top
= bs
->file
;
253 BdrvChild
*base
= s
->secondary_disk
;
259 ret
= replication_get_io_status(s
);
265 ret
= bdrv_co_pwritev(top
, sector_num
* BDRV_SECTOR_SIZE
,
266 remaining_sectors
* BDRV_SECTOR_SIZE
, qiov
, 0);
267 return replication_return_value(s
, ret
);
271 * Failover failed, only write to active disk if the sectors
272 * have already been allocated in active disk/hidden disk.
274 qemu_iovec_init(&hd_qiov
, qiov
->niov
);
275 while (remaining_sectors
> 0) {
278 ret
= bdrv_is_allocated_above(top
->bs
, base
->bs
, false,
279 sector_num
* BDRV_SECTOR_SIZE
,
280 remaining_sectors
* BDRV_SECTOR_SIZE
,
286 assert(QEMU_IS_ALIGNED(count
, BDRV_SECTOR_SIZE
));
287 n
= count
>> BDRV_SECTOR_BITS
;
288 qemu_iovec_reset(&hd_qiov
);
289 qemu_iovec_concat(&hd_qiov
, qiov
, bytes_done
, count
);
291 target
= ret
? top
: base
;
292 ret
= bdrv_co_pwritev(target
, sector_num
* BDRV_SECTOR_SIZE
,
293 n
* BDRV_SECTOR_SIZE
, &hd_qiov
, 0);
298 remaining_sectors
-= n
;
304 qemu_iovec_destroy(&hd_qiov
);
309 static bool replication_recurse_is_first_non_filter(BlockDriverState
*bs
,
310 BlockDriverState
*candidate
)
312 return bdrv_recurse_is_first_non_filter(bs
->file
->bs
, candidate
);
315 static void secondary_do_checkpoint(BDRVReplicationState
*s
, Error
**errp
)
317 Error
*local_err
= NULL
;
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 (!s
->active_disk
->bs
->drv
) {
332 error_setg(errp
, "Active disk %s is ejected",
333 s
->active_disk
->bs
->node_name
);
337 ret
= s
->active_disk
->bs
->drv
->bdrv_make_empty(s
->active_disk
->bs
);
339 error_setg(errp
, "Cannot make active disk empty");
343 if (!s
->hidden_disk
->bs
->drv
) {
344 error_setg(errp
, "Hidden disk %s is ejected",
345 s
->hidden_disk
->bs
->node_name
);
349 ret
= s
->hidden_disk
->bs
->drv
->bdrv_make_empty(s
->hidden_disk
->bs
);
351 error_setg(errp
, "Cannot make hidden disk empty");
356 /* This function is supposed to be called twice:
357 * first with writable = true, then with writable = false.
358 * The first call puts s->hidden_disk and s->secondary_disk in
359 * r/w mode, and the second puts them back in their original state.
361 static void reopen_backing_file(BlockDriverState
*bs
, bool writable
,
364 BDRVReplicationState
*s
= bs
->opaque
;
365 BlockReopenQueue
*reopen_queue
= NULL
;
366 Error
*local_err
= NULL
;
369 s
->orig_hidden_read_only
= bdrv_is_read_only(s
->hidden_disk
->bs
);
370 s
->orig_secondary_read_only
= bdrv_is_read_only(s
->secondary_disk
->bs
);
373 bdrv_subtree_drained_begin(s
->hidden_disk
->bs
);
374 bdrv_subtree_drained_begin(s
->secondary_disk
->bs
);
376 if (s
->orig_hidden_read_only
) {
377 QDict
*opts
= qdict_new();
378 qdict_put_bool(opts
, BDRV_OPT_READ_ONLY
, !writable
);
379 reopen_queue
= bdrv_reopen_queue(reopen_queue
, s
->hidden_disk
->bs
,
383 if (s
->orig_secondary_read_only
) {
384 QDict
*opts
= qdict_new();
385 qdict_put_bool(opts
, BDRV_OPT_READ_ONLY
, !writable
);
386 reopen_queue
= bdrv_reopen_queue(reopen_queue
, s
->secondary_disk
->bs
,
391 bdrv_reopen_multiple(reopen_queue
, &local_err
);
392 error_propagate(errp
, local_err
);
395 bdrv_subtree_drained_end(s
->hidden_disk
->bs
);
396 bdrv_subtree_drained_end(s
->secondary_disk
->bs
);
399 static void backup_job_cleanup(BlockDriverState
*bs
)
401 BDRVReplicationState
*s
= bs
->opaque
;
402 BlockDriverState
*top_bs
;
404 top_bs
= bdrv_lookup_bs(s
->top_id
, s
->top_id
, NULL
);
408 bdrv_op_unblock_all(top_bs
, s
->blocker
);
409 error_free(s
->blocker
);
410 reopen_backing_file(bs
, false, NULL
);
413 static void backup_job_completed(void *opaque
, int ret
)
415 BlockDriverState
*bs
= opaque
;
416 BDRVReplicationState
*s
= bs
->opaque
;
418 if (s
->stage
!= BLOCK_REPLICATION_FAILOVER
) {
419 /* The backup job is cancelled unexpectedly */
423 backup_job_cleanup(bs
);
426 static bool check_top_bs(BlockDriverState
*top_bs
, BlockDriverState
*bs
)
430 /* The bs itself is the top_bs */
435 /* Iterate over top_bs's children */
436 QLIST_FOREACH(child
, &top_bs
->children
, next
) {
437 if (child
->bs
== bs
|| check_top_bs(child
->bs
, bs
)) {
445 static void replication_start(ReplicationState
*rs
, ReplicationMode mode
,
448 BlockDriverState
*bs
= rs
->opaque
;
449 BDRVReplicationState
*s
;
450 BlockDriverState
*top_bs
;
451 int64_t active_length
, hidden_length
, disk_length
;
452 AioContext
*aio_context
;
453 Error
*local_err
= NULL
;
455 aio_context
= bdrv_get_aio_context(bs
);
456 aio_context_acquire(aio_context
);
459 if (s
->stage
!= BLOCK_REPLICATION_NONE
) {
460 error_setg(errp
, "Block replication is running or done");
461 aio_context_release(aio_context
);
465 if (s
->mode
!= mode
) {
466 error_setg(errp
, "The parameter mode's value is invalid, needs %d,"
467 " but got %d", s
->mode
, mode
);
468 aio_context_release(aio_context
);
473 case REPLICATION_MODE_PRIMARY
:
475 case REPLICATION_MODE_SECONDARY
:
476 s
->active_disk
= bs
->file
;
477 if (!s
->active_disk
|| !s
->active_disk
->bs
||
478 !s
->active_disk
->bs
->backing
) {
479 error_setg(errp
, "Active disk doesn't have backing file");
480 aio_context_release(aio_context
);
484 s
->hidden_disk
= s
->active_disk
->bs
->backing
;
485 if (!s
->hidden_disk
->bs
|| !s
->hidden_disk
->bs
->backing
) {
486 error_setg(errp
, "Hidden disk doesn't have backing file");
487 aio_context_release(aio_context
);
491 s
->secondary_disk
= s
->hidden_disk
->bs
->backing
;
492 if (!s
->secondary_disk
->bs
|| !bdrv_has_blk(s
->secondary_disk
->bs
)) {
493 error_setg(errp
, "The secondary disk doesn't have block backend");
494 aio_context_release(aio_context
);
498 /* verify the length */
499 active_length
= bdrv_getlength(s
->active_disk
->bs
);
500 hidden_length
= bdrv_getlength(s
->hidden_disk
->bs
);
501 disk_length
= bdrv_getlength(s
->secondary_disk
->bs
);
502 if (active_length
< 0 || hidden_length
< 0 || disk_length
< 0 ||
503 active_length
!= hidden_length
|| hidden_length
!= disk_length
) {
504 error_setg(errp
, "Active disk, hidden disk, secondary disk's length"
505 " are not the same");
506 aio_context_release(aio_context
);
510 /* Must be true, or the bdrv_getlength() calls would have failed */
511 assert(s
->active_disk
->bs
->drv
&& s
->hidden_disk
->bs
->drv
);
513 if (!s
->active_disk
->bs
->drv
->bdrv_make_empty
||
514 !s
->hidden_disk
->bs
->drv
->bdrv_make_empty
) {
516 "Active disk or hidden disk doesn't support make_empty");
517 aio_context_release(aio_context
);
521 /* reopen the backing file in r/w mode */
522 reopen_backing_file(bs
, true, &local_err
);
524 error_propagate(errp
, local_err
);
525 aio_context_release(aio_context
);
529 /* start backup job now */
530 error_setg(&s
->blocker
,
531 "Block device is in use by internal backup job");
533 top_bs
= bdrv_lookup_bs(s
->top_id
, s
->top_id
, NULL
);
534 if (!top_bs
|| !bdrv_is_root_node(top_bs
) ||
535 !check_top_bs(top_bs
, bs
)) {
536 error_setg(errp
, "No top_bs or it is invalid");
537 reopen_backing_file(bs
, false, NULL
);
538 aio_context_release(aio_context
);
541 bdrv_op_block_all(top_bs
, s
->blocker
);
542 bdrv_op_unblock(top_bs
, BLOCK_OP_TYPE_DATAPLANE
, s
->blocker
);
544 s
->backup_job
= backup_job_create(
545 NULL
, s
->secondary_disk
->bs
, s
->hidden_disk
->bs
,
546 0, MIRROR_SYNC_MODE_NONE
, NULL
, 0, false, NULL
,
547 BLOCKDEV_ON_ERROR_REPORT
,
548 BLOCKDEV_ON_ERROR_REPORT
, JOB_INTERNAL
,
549 backup_job_completed
, bs
, NULL
, &local_err
);
551 error_propagate(errp
, local_err
);
552 backup_job_cleanup(bs
);
553 aio_context_release(aio_context
);
556 job_start(&s
->backup_job
->job
);
559 aio_context_release(aio_context
);
563 s
->stage
= BLOCK_REPLICATION_RUNNING
;
565 if (s
->mode
== REPLICATION_MODE_SECONDARY
) {
566 secondary_do_checkpoint(s
, errp
);
570 aio_context_release(aio_context
);
573 static void replication_do_checkpoint(ReplicationState
*rs
, Error
**errp
)
575 BlockDriverState
*bs
= rs
->opaque
;
576 BDRVReplicationState
*s
;
577 AioContext
*aio_context
;
579 aio_context
= bdrv_get_aio_context(bs
);
580 aio_context_acquire(aio_context
);
583 if (s
->mode
== REPLICATION_MODE_SECONDARY
) {
584 secondary_do_checkpoint(s
, errp
);
586 aio_context_release(aio_context
);
589 static void replication_get_error(ReplicationState
*rs
, Error
**errp
)
591 BlockDriverState
*bs
= rs
->opaque
;
592 BDRVReplicationState
*s
;
593 AioContext
*aio_context
;
595 aio_context
= bdrv_get_aio_context(bs
);
596 aio_context_acquire(aio_context
);
599 if (s
->stage
!= BLOCK_REPLICATION_RUNNING
) {
600 error_setg(errp
, "Block replication is not running");
601 aio_context_release(aio_context
);
606 error_setg(errp
, "I/O error occurred");
607 aio_context_release(aio_context
);
610 aio_context_release(aio_context
);
613 static void replication_done(void *opaque
, int ret
)
615 BlockDriverState
*bs
= opaque
;
616 BDRVReplicationState
*s
= bs
->opaque
;
619 s
->stage
= BLOCK_REPLICATION_DONE
;
621 s
->active_disk
= NULL
;
622 s
->secondary_disk
= NULL
;
623 s
->hidden_disk
= NULL
;
626 s
->stage
= BLOCK_REPLICATION_FAILOVER_FAILED
;
631 static void replication_stop(ReplicationState
*rs
, bool failover
, Error
**errp
)
633 BlockDriverState
*bs
= rs
->opaque
;
634 BDRVReplicationState
*s
;
635 AioContext
*aio_context
;
637 aio_context
= bdrv_get_aio_context(bs
);
638 aio_context_acquire(aio_context
);
641 if (s
->stage
!= BLOCK_REPLICATION_RUNNING
) {
642 error_setg(errp
, "Block replication is not running");
643 aio_context_release(aio_context
);
648 case REPLICATION_MODE_PRIMARY
:
649 s
->stage
= BLOCK_REPLICATION_DONE
;
652 case REPLICATION_MODE_SECONDARY
:
654 * This BDS will be closed, and the job should be completed
655 * before the BDS is closed, because we will access hidden
656 * disk, secondary disk in backup_job_completed().
659 job_cancel_sync(&s
->backup_job
->job
);
663 secondary_do_checkpoint(s
, errp
);
664 s
->stage
= BLOCK_REPLICATION_DONE
;
665 aio_context_release(aio_context
);
669 s
->stage
= BLOCK_REPLICATION_FAILOVER
;
670 s
->commit_job
= commit_active_start(
671 NULL
, s
->active_disk
->bs
, s
->secondary_disk
->bs
,
672 JOB_INTERNAL
, 0, BLOCKDEV_ON_ERROR_REPORT
,
673 NULL
, replication_done
, bs
, true, errp
);
676 aio_context_release(aio_context
);
679 aio_context_release(aio_context
);
682 static const char *const replication_strong_runtime_opts
[] = {
689 static BlockDriver bdrv_replication
= {
690 .format_name
= "replication",
691 .instance_size
= sizeof(BDRVReplicationState
),
693 .bdrv_open
= replication_open
,
694 .bdrv_close
= replication_close
,
695 .bdrv_child_perm
= replication_child_perm
,
697 .bdrv_getlength
= replication_getlength
,
698 .bdrv_co_readv
= replication_co_readv
,
699 .bdrv_co_writev
= replication_co_writev
,
702 .bdrv_recurse_is_first_non_filter
= replication_recurse_is_first_non_filter
,
704 .has_variable_length
= true,
705 .strong_runtime_opts
= replication_strong_runtime_opts
,
708 static void bdrv_replication_init(void)
710 bdrv_register(&bdrv_replication
);
713 block_init(bdrv_replication_init
);