4 * Copyright (C) 2013 Proxmox Server Solutions
5 * Copyright (c) 2019 Virtuozzo International GmbH.
8 * Dietmar Maurer (dietmar@proxmox.com)
10 * This work is licensed under the terms of the GNU GPL, version 2 or later.
11 * See the COPYING file in the top-level directory.
15 #include "qemu/osdep.h"
18 #include "block/block.h"
19 #include "block/block_int.h"
20 #include "block/blockjob_int.h"
21 #include "block/block_backup.h"
22 #include "block/block-copy.h"
23 #include "block/dirty-bitmap.h"
24 #include "qapi/error.h"
25 #include "qapi/qmp/qerror.h"
26 #include "qemu/cutils.h"
27 #include "sysemu/block-backend.h"
28 #include "qemu/bitmap.h"
29 #include "qemu/error-report.h"
31 #include "block/copy-before-write.h"
33 typedef struct BackupBlockJob {
35 BlockDriverState *cbw;
36 BlockDriverState *source_bs;
37 BlockDriverState *target_bs;
39 BdrvDirtyBitmap *sync_bitmap;
41 MirrorSyncMode sync_mode;
42 BitmapSyncMode bitmap_mode;
43 BlockdevOnError on_source_error;
44 BlockdevOnError on_target_error;
52 BlockCopyCallState *bg_bcs_call;
55 static const BlockJobDriver backup_job_driver;
57 static void backup_cleanup_sync_bitmap(BackupBlockJob *job, int ret)
60 bool sync = (((ret == 0) || (job->bitmap_mode == BITMAP_SYNC_MODE_ALWAYS)) \
61 && (job->bitmap_mode != BITMAP_SYNC_MODE_NEVER));
65 * We succeeded, or we always intended to sync the bitmap.
66 * Delete this bitmap and install the child.
68 bm = bdrv_dirty_bitmap_abdicate(job->sync_bitmap, NULL);
71 * We failed, or we never intended to sync the bitmap anyway.
72 * Merge the successor back into the parent, keeping all data.
74 bm = bdrv_reclaim_dirty_bitmap(job->sync_bitmap, NULL);
79 if (ret < 0 && job->bitmap_mode == BITMAP_SYNC_MODE_ALWAYS) {
80 /* If we failed and synced, merge in the bits we didn't copy: */
81 bdrv_dirty_bitmap_merge_internal(bm, block_copy_dirty_bitmap(job->bcs),
86 static void backup_commit(Job *job)
88 BackupBlockJob *s = container_of(job, BackupBlockJob, common.job);
90 backup_cleanup_sync_bitmap(s, 0);
94 static void backup_abort(Job *job)
96 BackupBlockJob *s = container_of(job, BackupBlockJob, common.job);
98 backup_cleanup_sync_bitmap(s, -1);
102 static void backup_clean(Job *job)
104 BackupBlockJob *s = container_of(job, BackupBlockJob, common.job);
105 block_job_remove_all_bdrv(&s->common);
106 bdrv_cbw_drop(s->cbw);
109 void backup_do_checkpoint(BlockJob *job, Error **errp)
111 BackupBlockJob *backup_job = container_of(job, BackupBlockJob, common);
113 assert(block_job_driver(job) == &backup_job_driver);
115 if (backup_job->sync_mode != MIRROR_SYNC_MODE_NONE) {
116 error_setg(errp, "The backup job only supports block checkpoint in"
121 bdrv_set_dirty_bitmap(block_copy_dirty_bitmap(backup_job->bcs), 0,
125 static BlockErrorAction backup_error_action(BackupBlockJob *job,
126 bool read, int error)
129 return block_job_error_action(&job->common, job->on_source_error,
132 return block_job_error_action(&job->common, job->on_target_error,
137 static void coroutine_fn backup_block_copy_callback(void *opaque)
139 BackupBlockJob *s = opaque;
143 aio_co_wake(s->common.job.co);
145 job_enter(&s->common.job);
149 static int coroutine_fn backup_loop(BackupBlockJob *job)
151 BlockCopyCallState *s = NULL;
154 BlockErrorAction act;
156 while (true) { /* retry loop */
157 job->bg_bcs_call = s = block_copy_async(job->bcs, 0,
158 QEMU_ALIGN_UP(job->len, job->cluster_size),
159 job->perf.max_workers, job->perf.max_chunk,
160 backup_block_copy_callback, job);
162 while (!block_copy_call_finished(s) &&
163 !job_is_cancelled(&job->common.job))
165 job_yield(&job->common.job);
168 if (!block_copy_call_finished(s)) {
169 assert(job_is_cancelled(&job->common.job));
171 * Note that we can't use job_yield() here, as it doesn't work for
174 block_copy_call_cancel(s);
176 qemu_coroutine_yield();
177 assert(block_copy_call_finished(s));
182 if (job_is_cancelled(&job->common.job) ||
183 block_copy_call_succeeded(s))
189 if (block_copy_call_cancelled(s)) {
191 * Job is not cancelled but only block-copy call. This is possible
192 * after job pause. Now the pause is finished, start new block-copy
195 block_copy_call_free(s);
199 /* The only remaining case is failed block-copy call. */
200 assert(block_copy_call_failed(s));
202 ret = block_copy_call_status(s, &error_is_read);
203 act = backup_error_action(job, error_is_read, -ret);
205 case BLOCK_ERROR_ACTION_REPORT:
207 case BLOCK_ERROR_ACTION_STOP:
209 * Go to pause prior to starting new block-copy call on the next
212 job_pause_point(&job->common.job);
214 case BLOCK_ERROR_ACTION_IGNORE:
215 /* Proceed to new block-copy call to retry. */
221 block_copy_call_free(s);
225 block_copy_call_free(s);
226 job->bg_bcs_call = NULL;
230 static void backup_init_bcs_bitmap(BackupBlockJob *job)
233 BdrvDirtyBitmap *bcs_bitmap = block_copy_dirty_bitmap(job->bcs);
235 if (job->sync_mode == MIRROR_SYNC_MODE_BITMAP) {
236 bdrv_clear_dirty_bitmap(bcs_bitmap, NULL);
237 bdrv_dirty_bitmap_merge_internal(bcs_bitmap, job->sync_bitmap, NULL,
239 } else if (job->sync_mode == MIRROR_SYNC_MODE_TOP) {
241 * We can't hog the coroutine to initialize this thoroughly.
242 * Set a flag and resume work when we are able to yield safely.
244 block_copy_set_skip_unallocated(job->bcs, true);
247 estimate = bdrv_get_dirty_count(bcs_bitmap);
248 job_progress_set_remaining(&job->common.job, estimate);
251 static int coroutine_fn backup_run(Job *job, Error **errp)
253 BackupBlockJob *s = container_of(job, BackupBlockJob, common.job);
256 backup_init_bcs_bitmap(s);
258 if (s->sync_mode == MIRROR_SYNC_MODE_TOP) {
262 for (offset = 0; offset < s->len; ) {
263 if (job_is_cancelled(job)) {
267 job_pause_point(job);
269 if (job_is_cancelled(job)) {
273 ret = block_copy_reset_unallocated(s->bcs, offset, &count);
280 block_copy_set_skip_unallocated(s->bcs, false);
283 if (s->sync_mode == MIRROR_SYNC_MODE_NONE) {
285 * All bits are set in bcs bitmap to allow any cluster to be copied.
286 * This does not actually require them to be copied.
288 while (!job_is_cancelled(job)) {
290 * Yield until the job is cancelled. We just let our before_write
291 * notify callback service CoW requests.
296 return backup_loop(s);
302 static void coroutine_fn backup_pause(Job *job)
304 BackupBlockJob *s = container_of(job, BackupBlockJob, common.job);
306 if (s->bg_bcs_call && !block_copy_call_finished(s->bg_bcs_call)) {
307 block_copy_call_cancel(s->bg_bcs_call);
309 qemu_coroutine_yield();
313 static void backup_set_speed(BlockJob *job, int64_t speed)
315 BackupBlockJob *s = container_of(job, BackupBlockJob, common);
318 * block_job_set_speed() is called first from block_job_create(), when we
319 * don't yet have s->bcs.
322 block_copy_set_speed(s->bcs, speed);
323 if (s->bg_bcs_call) {
324 block_copy_kick(s->bg_bcs_call);
329 static bool backup_cancel(Job *job, bool force)
331 BackupBlockJob *s = container_of(job, BackupBlockJob, common.job);
333 bdrv_cancel_in_flight(s->target_bs);
337 static const BlockJobDriver backup_job_driver = {
339 .instance_size = sizeof(BackupBlockJob),
340 .job_type = JOB_TYPE_BACKUP,
341 .free = block_job_free,
342 .user_resume = block_job_user_resume,
344 .commit = backup_commit,
345 .abort = backup_abort,
346 .clean = backup_clean,
347 .pause = backup_pause,
348 .cancel = backup_cancel,
350 .set_speed = backup_set_speed,
353 BlockJob *backup_job_create(const char *job_id, BlockDriverState *bs,
354 BlockDriverState *target, int64_t speed,
355 MirrorSyncMode sync_mode, BdrvDirtyBitmap *sync_bitmap,
356 BitmapSyncMode bitmap_mode,
358 const char *filter_node_name,
360 BlockdevOnError on_source_error,
361 BlockdevOnError on_target_error,
363 BlockCompletionFunc *cb, void *opaque,
364 JobTxn *txn, Error **errp)
366 int64_t len, target_len;
367 BackupBlockJob *job = NULL;
368 int64_t cluster_size;
369 BlockDriverState *cbw = NULL;
370 BlockCopyState *bcs = NULL;
376 /* QMP interface protects us from these cases */
377 assert(sync_mode != MIRROR_SYNC_MODE_INCREMENTAL);
378 assert(sync_bitmap || sync_mode != MIRROR_SYNC_MODE_BITMAP);
381 error_setg(errp, "Source and target cannot be the same");
385 if (!bdrv_is_inserted(bs)) {
386 error_setg(errp, "Device is not inserted: %s",
387 bdrv_get_device_name(bs));
391 if (!bdrv_is_inserted(target)) {
392 error_setg(errp, "Device is not inserted: %s",
393 bdrv_get_device_name(target));
397 if (compress && !bdrv_supports_compressed_writes(target)) {
398 error_setg(errp, "Compression is not supported for this drive %s",
399 bdrv_get_device_name(target));
403 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
407 if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_BACKUP_TARGET, errp)) {
411 if (perf->max_workers < 1 || perf->max_workers > INT_MAX) {
412 error_setg(errp, "max-workers must be between 1 and %d", INT_MAX);
416 if (perf->max_chunk < 0) {
417 error_setg(errp, "max-chunk must be zero (which means no limit) or "
423 /* If we need to write to this bitmap, check that we can: */
424 if (bitmap_mode != BITMAP_SYNC_MODE_NEVER &&
425 bdrv_dirty_bitmap_check(sync_bitmap, BDRV_BITMAP_DEFAULT, errp)) {
429 /* Create a new bitmap, and freeze/disable this one. */
430 if (bdrv_dirty_bitmap_create_successor(sync_bitmap, errp) < 0) {
435 len = bdrv_getlength(bs);
437 error_setg_errno(errp, -len, "Unable to get length for '%s'",
438 bdrv_get_device_or_node_name(bs));
442 target_len = bdrv_getlength(target);
443 if (target_len < 0) {
444 error_setg_errno(errp, -target_len, "Unable to get length for '%s'",
445 bdrv_get_device_or_node_name(bs));
449 if (target_len != len) {
450 error_setg(errp, "Source and target image have different sizes");
454 cbw = bdrv_cbw_append(bs, target, filter_node_name, &bcs, errp);
459 cluster_size = block_copy_cluster_size(bcs);
461 if (perf->max_chunk && perf->max_chunk < cluster_size) {
462 error_setg(errp, "Required max-chunk (%" PRIi64 ") is less than backup "
463 "cluster size (%" PRIi64 ")", perf->max_chunk, cluster_size);
467 /* job->len is fixed, so we can't allow resize */
468 job = block_job_create(job_id, &backup_job_driver, txn, cbw,
470 speed, creation_flags, cb, opaque, errp);
477 job->target_bs = target;
478 job->on_source_error = on_source_error;
479 job->on_target_error = on_target_error;
480 job->sync_mode = sync_mode;
481 job->sync_bitmap = sync_bitmap;
482 job->bitmap_mode = bitmap_mode;
484 job->cluster_size = cluster_size;
488 block_copy_set_copy_opts(bcs, perf->use_copy_range, compress);
489 block_copy_set_progress_meter(bcs, &job->common.job.progress);
490 block_copy_set_speed(bcs, speed);
492 /* Required permissions are taken by copy-before-write filter target */
493 block_job_add_bdrv(&job->common, "target", target, 0, BLK_PERM_ALL,
500 bdrv_reclaim_dirty_bitmap(sync_bitmap, NULL);