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-common.h"
17 #include "block/nbd.h"
18 #include "block/blockjob.h"
19 #include "block/block_int.h"
20 #include "block/block_backup.h"
21 #include "sysemu/block-backend.h"
22 #include "qapi/error.h"
23 #include "replication.h"
26 BLOCK_REPLICATION_NONE
, /* block replication is not started */
27 BLOCK_REPLICATION_RUNNING
, /* block replication is running */
28 BLOCK_REPLICATION_FAILOVER
, /* failover is running in background */
29 BLOCK_REPLICATION_FAILOVER_FAILED
, /* failover failed */
30 BLOCK_REPLICATION_DONE
, /* block replication is done */
33 typedef struct BDRVReplicationState
{
35 ReplicationStage stage
;
36 BdrvChild
*active_disk
;
37 BdrvChild
*hidden_disk
;
38 BdrvChild
*secondary_disk
;
42 int orig_hidden_flags
;
43 int orig_secondary_flags
;
45 } BDRVReplicationState
;
47 static void replication_start(ReplicationState
*rs
, ReplicationMode mode
,
49 static void replication_do_checkpoint(ReplicationState
*rs
, Error
**errp
);
50 static void replication_get_error(ReplicationState
*rs
, Error
**errp
);
51 static void replication_stop(ReplicationState
*rs
, bool failover
,
54 #define REPLICATION_MODE "mode"
55 #define REPLICATION_TOP_ID "top-id"
56 static QemuOptsList replication_runtime_opts
= {
57 .name
= "replication",
58 .head
= QTAILQ_HEAD_INITIALIZER(replication_runtime_opts
.head
),
61 .name
= REPLICATION_MODE
,
62 .type
= QEMU_OPT_STRING
,
65 .name
= REPLICATION_TOP_ID
,
66 .type
= QEMU_OPT_STRING
,
72 static ReplicationOps replication_ops
= {
73 .start
= replication_start
,
74 .checkpoint
= replication_do_checkpoint
,
75 .get_error
= replication_get_error
,
76 .stop
= replication_stop
,
79 static int replication_open(BlockDriverState
*bs
, QDict
*options
,
80 int flags
, Error
**errp
)
83 BDRVReplicationState
*s
= bs
->opaque
;
84 Error
*local_err
= NULL
;
85 QemuOpts
*opts
= NULL
;
89 bs
->file
= bdrv_open_child(NULL
, options
, "file", bs
, &child_file
,
96 opts
= qemu_opts_create(&replication_runtime_opts
, NULL
, 0, &error_abort
);
97 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
102 mode
= qemu_opt_get(opts
, REPLICATION_MODE
);
104 error_setg(&local_err
, "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
);
112 error_setg(&local_err
, "The primary side does not support option top-id");
115 } else if (!strcmp(mode
, "secondary")) {
116 s
->mode
= REPLICATION_MODE_SECONDARY
;
117 top_id
= qemu_opt_get(opts
, REPLICATION_TOP_ID
);
118 s
->top_id
= g_strdup(top_id
);
120 error_setg(&local_err
, "Missing the option top-id");
124 error_setg(&local_err
,
125 "The option mode's value should be primary or secondary");
129 s
->rs
= replication_new(bs
, &replication_ops
);
135 error_propagate(errp
, local_err
);
140 static void replication_close(BlockDriverState
*bs
)
142 BDRVReplicationState
*s
= bs
->opaque
;
144 if (s
->stage
== BLOCK_REPLICATION_RUNNING
) {
145 replication_stop(s
->rs
, false, NULL
);
147 if (s
->stage
== BLOCK_REPLICATION_FAILOVER
) {
148 block_job_cancel_sync(s
->active_disk
->bs
->job
);
151 if (s
->mode
== REPLICATION_MODE_SECONDARY
) {
155 replication_remove(s
->rs
);
158 static void replication_child_perm(BlockDriverState
*bs
, BdrvChild
*c
,
159 const BdrvChildRole
*role
,
160 BlockReopenQueue
*reopen_queue
,
161 uint64_t perm
, uint64_t shared
,
162 uint64_t *nperm
, uint64_t *nshared
)
164 *nperm
= *nshared
= BLK_PERM_CONSISTENT_READ \
166 | BLK_PERM_WRITE_UNCHANGED
;
171 static int64_t replication_getlength(BlockDriverState
*bs
)
173 return bdrv_getlength(bs
->file
->bs
);
176 static int replication_get_io_status(BDRVReplicationState
*s
)
179 case BLOCK_REPLICATION_NONE
:
181 case BLOCK_REPLICATION_RUNNING
:
183 case BLOCK_REPLICATION_FAILOVER
:
184 return s
->mode
== REPLICATION_MODE_PRIMARY
? -EIO
: 0;
185 case BLOCK_REPLICATION_FAILOVER_FAILED
:
186 return s
->mode
== REPLICATION_MODE_PRIMARY
? -EIO
: 1;
187 case BLOCK_REPLICATION_DONE
:
189 * active commit job completes, and active disk and secondary_disk
190 * is swapped, so we can operate bs->file directly
192 return s
->mode
== REPLICATION_MODE_PRIMARY
? -EIO
: 0;
198 static int replication_return_value(BDRVReplicationState
*s
, int ret
)
200 if (s
->mode
== REPLICATION_MODE_SECONDARY
) {
212 static coroutine_fn
int replication_co_readv(BlockDriverState
*bs
,
214 int remaining_sectors
,
217 BDRVReplicationState
*s
= bs
->opaque
;
218 BdrvChild
*child
= s
->secondary_disk
;
219 BlockJob
*job
= NULL
;
223 if (s
->mode
== REPLICATION_MODE_PRIMARY
) {
224 /* We only use it to forward primary write requests */
228 ret
= replication_get_io_status(s
);
233 if (child
&& child
->bs
) {
234 job
= child
->bs
->job
;
238 uint64_t remaining_bytes
= remaining_sectors
* BDRV_SECTOR_SIZE
;
240 backup_wait_for_overlapping_requests(child
->bs
->job
,
241 sector_num
* BDRV_SECTOR_SIZE
,
243 backup_cow_request_begin(&req
, child
->bs
->job
,
244 sector_num
* BDRV_SECTOR_SIZE
,
246 ret
= bdrv_co_readv(bs
->file
, sector_num
, remaining_sectors
,
248 backup_cow_request_end(&req
);
252 ret
= bdrv_co_readv(bs
->file
, sector_num
, remaining_sectors
, qiov
);
254 return replication_return_value(s
, ret
);
257 static coroutine_fn
int replication_co_writev(BlockDriverState
*bs
,
259 int remaining_sectors
,
262 BDRVReplicationState
*s
= bs
->opaque
;
263 QEMUIOVector hd_qiov
;
264 uint64_t bytes_done
= 0;
265 BdrvChild
*top
= bs
->file
;
266 BdrvChild
*base
= s
->secondary_disk
;
271 ret
= replication_get_io_status(s
);
277 ret
= bdrv_co_writev(top
, sector_num
,
278 remaining_sectors
, qiov
);
279 return replication_return_value(s
, ret
);
283 * Failover failed, only write to active disk if the sectors
284 * have already been allocated in active disk/hidden disk.
286 qemu_iovec_init(&hd_qiov
, qiov
->niov
);
287 while (remaining_sectors
> 0) {
290 ret
= bdrv_is_allocated_above(top
->bs
, base
->bs
,
291 sector_num
* BDRV_SECTOR_SIZE
,
292 remaining_sectors
* BDRV_SECTOR_SIZE
,
298 assert(QEMU_IS_ALIGNED(count
, BDRV_SECTOR_SIZE
));
299 n
= count
>> BDRV_SECTOR_BITS
;
300 qemu_iovec_reset(&hd_qiov
);
301 qemu_iovec_concat(&hd_qiov
, qiov
, bytes_done
, count
);
303 target
= ret
? top
: base
;
304 ret
= bdrv_co_writev(target
, sector_num
, n
, &hd_qiov
);
309 remaining_sectors
-= n
;
315 qemu_iovec_destroy(&hd_qiov
);
320 static bool replication_recurse_is_first_non_filter(BlockDriverState
*bs
,
321 BlockDriverState
*candidate
)
323 return bdrv_recurse_is_first_non_filter(bs
->file
->bs
, candidate
);
326 static void secondary_do_checkpoint(BDRVReplicationState
*s
, Error
**errp
)
328 Error
*local_err
= NULL
;
331 if (!s
->secondary_disk
->bs
->job
) {
332 error_setg(errp
, "Backup job was cancelled unexpectedly");
336 backup_do_checkpoint(s
->secondary_disk
->bs
->job
, &local_err
);
338 error_propagate(errp
, local_err
);
342 ret
= s
->active_disk
->bs
->drv
->bdrv_make_empty(s
->active_disk
->bs
);
344 error_setg(errp
, "Cannot make active disk empty");
348 ret
= s
->hidden_disk
->bs
->drv
->bdrv_make_empty(s
->hidden_disk
->bs
);
350 error_setg(errp
, "Cannot make hidden disk empty");
355 static void reopen_backing_file(BlockDriverState
*bs
, bool writable
,
358 BDRVReplicationState
*s
= bs
->opaque
;
359 BlockReopenQueue
*reopen_queue
= NULL
;
360 int orig_hidden_flags
, orig_secondary_flags
;
361 int new_hidden_flags
, new_secondary_flags
;
362 Error
*local_err
= NULL
;
365 orig_hidden_flags
= s
->orig_hidden_flags
=
366 bdrv_get_flags(s
->hidden_disk
->bs
);
367 new_hidden_flags
= (orig_hidden_flags
| BDRV_O_RDWR
) &
369 orig_secondary_flags
= s
->orig_secondary_flags
=
370 bdrv_get_flags(s
->secondary_disk
->bs
);
371 new_secondary_flags
= (orig_secondary_flags
| BDRV_O_RDWR
) &
374 orig_hidden_flags
= (s
->orig_hidden_flags
| BDRV_O_RDWR
) &
376 new_hidden_flags
= s
->orig_hidden_flags
;
377 orig_secondary_flags
= (s
->orig_secondary_flags
| BDRV_O_RDWR
) &
379 new_secondary_flags
= s
->orig_secondary_flags
;
382 if (orig_hidden_flags
!= new_hidden_flags
) {
383 reopen_queue
= bdrv_reopen_queue(reopen_queue
, s
->hidden_disk
->bs
, NULL
,
387 if (!(orig_secondary_flags
& BDRV_O_RDWR
)) {
388 reopen_queue
= bdrv_reopen_queue(reopen_queue
, s
->secondary_disk
->bs
,
389 NULL
, new_secondary_flags
);
393 bdrv_reopen_multiple(bdrv_get_aio_context(bs
),
394 reopen_queue
, &local_err
);
395 error_propagate(errp
, local_err
);
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
;
456 aio_context
= bdrv_get_aio_context(bs
);
457 aio_context_acquire(aio_context
);
460 if (s
->stage
!= BLOCK_REPLICATION_NONE
) {
461 error_setg(errp
, "Block replication is running or done");
462 aio_context_release(aio_context
);
466 if (s
->mode
!= mode
) {
467 error_setg(errp
, "The parameter mode's value is invalid, needs %d,"
468 " but got %d", s
->mode
, mode
);
469 aio_context_release(aio_context
);
474 case REPLICATION_MODE_PRIMARY
:
476 case REPLICATION_MODE_SECONDARY
:
477 s
->active_disk
= bs
->file
;
478 if (!s
->active_disk
|| !s
->active_disk
->bs
||
479 !s
->active_disk
->bs
->backing
) {
480 error_setg(errp
, "Active disk doesn't have backing file");
481 aio_context_release(aio_context
);
485 s
->hidden_disk
= s
->active_disk
->bs
->backing
;
486 if (!s
->hidden_disk
->bs
|| !s
->hidden_disk
->bs
->backing
) {
487 error_setg(errp
, "Hidden disk doesn't have backing file");
488 aio_context_release(aio_context
);
492 s
->secondary_disk
= s
->hidden_disk
->bs
->backing
;
493 if (!s
->secondary_disk
->bs
|| !bdrv_has_blk(s
->secondary_disk
->bs
)) {
494 error_setg(errp
, "The secondary disk doesn't have block backend");
495 aio_context_release(aio_context
);
499 /* verify the length */
500 active_length
= bdrv_getlength(s
->active_disk
->bs
);
501 hidden_length
= bdrv_getlength(s
->hidden_disk
->bs
);
502 disk_length
= bdrv_getlength(s
->secondary_disk
->bs
);
503 if (active_length
< 0 || hidden_length
< 0 || disk_length
< 0 ||
504 active_length
!= hidden_length
|| hidden_length
!= disk_length
) {
505 error_setg(errp
, "Active disk, hidden disk, secondary disk's length"
506 " are not the same");
507 aio_context_release(aio_context
);
511 if (!s
->active_disk
->bs
->drv
->bdrv_make_empty
||
512 !s
->hidden_disk
->bs
->drv
->bdrv_make_empty
) {
514 "Active disk or hidden disk doesn't support make_empty");
515 aio_context_release(aio_context
);
519 /* reopen the backing file in r/w mode */
520 reopen_backing_file(bs
, true, &local_err
);
522 error_propagate(errp
, local_err
);
523 aio_context_release(aio_context
);
527 /* start backup job now */
528 error_setg(&s
->blocker
,
529 "Block device is in use by internal backup job");
531 top_bs
= bdrv_lookup_bs(s
->top_id
, s
->top_id
, NULL
);
532 if (!top_bs
|| !bdrv_is_root_node(top_bs
) ||
533 !check_top_bs(top_bs
, bs
)) {
534 error_setg(errp
, "No top_bs or it is invalid");
535 reopen_backing_file(bs
, false, NULL
);
536 aio_context_release(aio_context
);
539 bdrv_op_block_all(top_bs
, s
->blocker
);
540 bdrv_op_unblock(top_bs
, BLOCK_OP_TYPE_DATAPLANE
, s
->blocker
);
542 job
= backup_job_create(NULL
, s
->secondary_disk
->bs
, s
->hidden_disk
->bs
,
543 0, MIRROR_SYNC_MODE_NONE
, NULL
, false,
544 BLOCKDEV_ON_ERROR_REPORT
,
545 BLOCKDEV_ON_ERROR_REPORT
, BLOCK_JOB_INTERNAL
,
546 backup_job_completed
, bs
, NULL
, &local_err
);
548 error_propagate(errp
, local_err
);
549 backup_job_cleanup(bs
);
550 aio_context_release(aio_context
);
553 block_job_start(job
);
556 aio_context_release(aio_context
);
560 s
->stage
= BLOCK_REPLICATION_RUNNING
;
562 if (s
->mode
== REPLICATION_MODE_SECONDARY
) {
563 secondary_do_checkpoint(s
, errp
);
567 aio_context_release(aio_context
);
570 static void replication_do_checkpoint(ReplicationState
*rs
, Error
**errp
)
572 BlockDriverState
*bs
= rs
->opaque
;
573 BDRVReplicationState
*s
;
574 AioContext
*aio_context
;
576 aio_context
= bdrv_get_aio_context(bs
);
577 aio_context_acquire(aio_context
);
580 if (s
->mode
== REPLICATION_MODE_SECONDARY
) {
581 secondary_do_checkpoint(s
, errp
);
583 aio_context_release(aio_context
);
586 static void replication_get_error(ReplicationState
*rs
, Error
**errp
)
588 BlockDriverState
*bs
= rs
->opaque
;
589 BDRVReplicationState
*s
;
590 AioContext
*aio_context
;
592 aio_context
= bdrv_get_aio_context(bs
);
593 aio_context_acquire(aio_context
);
596 if (s
->stage
!= BLOCK_REPLICATION_RUNNING
) {
597 error_setg(errp
, "Block replication is not running");
598 aio_context_release(aio_context
);
603 error_setg(errp
, "I/O error occurred");
604 aio_context_release(aio_context
);
607 aio_context_release(aio_context
);
610 static void replication_done(void *opaque
, int ret
)
612 BlockDriverState
*bs
= opaque
;
613 BDRVReplicationState
*s
= bs
->opaque
;
616 s
->stage
= BLOCK_REPLICATION_DONE
;
618 /* refresh top bs's filename */
619 bdrv_refresh_filename(bs
);
620 s
->active_disk
= NULL
;
621 s
->secondary_disk
= NULL
;
622 s
->hidden_disk
= NULL
;
625 s
->stage
= BLOCK_REPLICATION_FAILOVER_FAILED
;
630 static void replication_stop(ReplicationState
*rs
, bool failover
, Error
**errp
)
632 BlockDriverState
*bs
= rs
->opaque
;
633 BDRVReplicationState
*s
;
634 AioContext
*aio_context
;
636 aio_context
= bdrv_get_aio_context(bs
);
637 aio_context_acquire(aio_context
);
640 if (s
->stage
!= BLOCK_REPLICATION_RUNNING
) {
641 error_setg(errp
, "Block replication is not running");
642 aio_context_release(aio_context
);
647 case REPLICATION_MODE_PRIMARY
:
648 s
->stage
= BLOCK_REPLICATION_DONE
;
651 case REPLICATION_MODE_SECONDARY
:
653 * This BDS will be closed, and the job should be completed
654 * before the BDS is closed, because we will access hidden
655 * disk, secondary disk in backup_job_completed().
657 if (s
->secondary_disk
->bs
->job
) {
658 block_job_cancel_sync(s
->secondary_disk
->bs
->job
);
662 secondary_do_checkpoint(s
, errp
);
663 s
->stage
= BLOCK_REPLICATION_DONE
;
664 aio_context_release(aio_context
);
668 s
->stage
= BLOCK_REPLICATION_FAILOVER
;
669 commit_active_start(NULL
, s
->active_disk
->bs
, s
->secondary_disk
->bs
,
670 BLOCK_JOB_INTERNAL
, 0, BLOCKDEV_ON_ERROR_REPORT
,
671 NULL
, replication_done
, bs
, true, errp
);
674 aio_context_release(aio_context
);
677 aio_context_release(aio_context
);
680 BlockDriver bdrv_replication
= {
681 .format_name
= "replication",
682 .protocol_name
= "replication",
683 .instance_size
= sizeof(BDRVReplicationState
),
685 .bdrv_open
= replication_open
,
686 .bdrv_close
= replication_close
,
687 .bdrv_child_perm
= replication_child_perm
,
689 .bdrv_getlength
= replication_getlength
,
690 .bdrv_co_readv
= replication_co_readv
,
691 .bdrv_co_writev
= replication_co_writev
,
694 .bdrv_recurse_is_first_non_filter
= replication_recurse_is_first_non_filter
,
696 .has_variable_length
= true,
699 static void bdrv_replication_init(void)
701 bdrv_register(&bdrv_replication
);
704 block_init(bdrv_replication_init
);