4 * Copyright (C) 2013 Proxmox Server Solutions
5 * Copyright (c) 2019 Virtuozzo International GmbH.
8 * Dietmar Maurer (dietmar@proxmox.com)
9 * Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.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.
18 #include "block/block.h"
19 #include "qemu/co-shared-resource.h"
21 /* All APIs are thread-safe */
23 typedef void (*BlockCopyAsyncCallbackFunc
)(void *opaque
);
24 typedef struct BlockCopyState BlockCopyState
;
25 typedef struct BlockCopyCallState BlockCopyCallState
;
27 BlockCopyState
*block_copy_state_new(BdrvChild
*source
, BdrvChild
*target
,
30 /* Function should be called prior any actual copy request */
31 void block_copy_set_copy_opts(BlockCopyState
*s
, bool use_copy_range
,
33 void block_copy_set_progress_meter(BlockCopyState
*s
, ProgressMeter
*pm
);
35 void block_copy_state_free(BlockCopyState
*s
);
37 int64_t block_copy_reset_unallocated(BlockCopyState
*s
,
38 int64_t offset
, int64_t *count
);
40 int coroutine_fn
block_copy(BlockCopyState
*s
, int64_t offset
, int64_t bytes
,
41 bool ignore_ratelimit
);
44 * Run block-copy in a coroutine, create corresponding BlockCopyCallState
45 * object and return pointer to it. Never returns NULL.
47 * Caller is responsible to call block_copy_call_free() to free
48 * BlockCopyCallState object.
50 * @max_workers means maximum of parallel coroutines to execute sub-requests,
53 * @max_chunk means maximum length for one IO operation. Zero means unlimited.
55 BlockCopyCallState
*block_copy_async(BlockCopyState
*s
,
56 int64_t offset
, int64_t bytes
,
57 int max_workers
, int64_t max_chunk
,
58 BlockCopyAsyncCallbackFunc cb
,
62 * Free finished BlockCopyCallState. Trying to free running
63 * block-copy will crash.
65 void block_copy_call_free(BlockCopyCallState
*call_state
);
68 * Note, that block-copy call is marked finished prior to calling
71 bool block_copy_call_finished(BlockCopyCallState
*call_state
);
72 bool block_copy_call_succeeded(BlockCopyCallState
*call_state
);
73 bool block_copy_call_failed(BlockCopyCallState
*call_state
);
74 bool block_copy_call_cancelled(BlockCopyCallState
*call_state
);
75 int block_copy_call_status(BlockCopyCallState
*call_state
, bool *error_is_read
);
77 void block_copy_set_speed(BlockCopyState
*s
, uint64_t speed
);
78 void block_copy_kick(BlockCopyCallState
*call_state
);
81 * Cancel running block-copy call.
83 * Cancel leaves block-copy state valid: dirty bits are correct and you may use
84 * cancel + <run block_copy with same parameters> to emulate pause/resume.
86 * Note also, that the cancel is async: it only marks block-copy call to be
87 * cancelled. So, the call may be cancelled (block_copy_call_cancelled() reports
88 * true) but not yet finished (block_copy_call_finished() reports false).
90 void block_copy_call_cancel(BlockCopyCallState
*call_state
);
92 BdrvDirtyBitmap
*block_copy_dirty_bitmap(BlockCopyState
*s
);
93 int64_t block_copy_cluster_size(BlockCopyState
*s
);
94 void block_copy_set_skip_unallocated(BlockCopyState
*s
, bool skip
);
96 #endif /* BLOCK_COPY_H */