1 /* 2 * block_copy API 3 * 4 * Copyright (C) 2013 Proxmox Server Solutions 5 * Copyright (c) 2019 Virtuozzo International GmbH. 6 * 7 * Authors: 8 * Dietmar Maurer (dietmar@proxmox.com) 9 * Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com> 10 * 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. 13 */ 14 15 #ifndef BLOCK_COPY_H 16 #define BLOCK_COPY_H 17 18 #include "block/block-common.h" 19 #include "qemu/progress_meter.h" 20 21 /* All APIs are thread-safe */ 22 23 typedef void (*BlockCopyAsyncCallbackFunc)(void *opaque); 24 typedef struct BlockCopyState BlockCopyState; 25 typedef struct BlockCopyCallState BlockCopyCallState; 26 27 BlockCopyState *block_copy_state_new(BdrvChild *source, BdrvChild *target, 28 BlockDriverState *copy_bitmap_bs, 29 const BdrvDirtyBitmap *bitmap, 30 bool discard_source, 31 Error **errp); 32 33 /* Function should be called prior any actual copy request */ 34 void block_copy_set_copy_opts(BlockCopyState *s, bool use_copy_range, 35 bool compress); 36 void block_copy_set_progress_meter(BlockCopyState *s, ProgressMeter *pm); 37 38 void block_copy_state_free(BlockCopyState *s); 39 40 void block_copy_reset(BlockCopyState *s, int64_t offset, int64_t bytes); 41 42 int64_t coroutine_fn GRAPH_RDLOCK 43 block_copy_reset_unallocated(BlockCopyState *s, int64_t offset, int64_t *count); 44 45 int coroutine_fn block_copy(BlockCopyState *s, int64_t offset, int64_t bytes, 46 bool ignore_ratelimit, uint64_t timeout_ns, 47 BlockCopyAsyncCallbackFunc cb, 48 void *cb_opaque); 49 50 /* 51 * Run block-copy in a coroutine, create corresponding BlockCopyCallState 52 * object and return pointer to it. Never returns NULL. 53 * 54 * Caller is responsible to call block_copy_call_free() to free 55 * BlockCopyCallState object. 56 * 57 * @max_workers means maximum of parallel coroutines to execute sub-requests, 58 * must be > 0. 59 * 60 * @max_chunk means maximum length for one IO operation. Zero means unlimited. 61 */ 62 BlockCopyCallState *block_copy_async(BlockCopyState *s, 63 int64_t offset, int64_t bytes, 64 int max_workers, int64_t max_chunk, 65 BlockCopyAsyncCallbackFunc cb, 66 void *cb_opaque); 67 68 /* 69 * Free finished BlockCopyCallState. Trying to free running 70 * block-copy will crash. 71 */ 72 void block_copy_call_free(BlockCopyCallState *call_state); 73 74 /* 75 * Note, that block-copy call is marked finished prior to calling 76 * the callback. 77 */ 78 bool block_copy_call_finished(BlockCopyCallState *call_state); 79 bool block_copy_call_succeeded(BlockCopyCallState *call_state); 80 bool block_copy_call_failed(BlockCopyCallState *call_state); 81 bool block_copy_call_cancelled(BlockCopyCallState *call_state); 82 int block_copy_call_status(BlockCopyCallState *call_state, bool *error_is_read); 83 84 void block_copy_set_speed(BlockCopyState *s, uint64_t speed); 85 void block_copy_kick(BlockCopyCallState *call_state); 86 87 /* 88 * Cancel running block-copy call. 89 * 90 * Cancel leaves block-copy state valid: dirty bits are correct and you may use 91 * cancel + <run block_copy with same parameters> to emulate pause/resume. 92 * 93 * Note also, that the cancel is async: it only marks block-copy call to be 94 * cancelled. So, the call may be cancelled (block_copy_call_cancelled() reports 95 * true) but not yet finished (block_copy_call_finished() reports false). 96 */ 97 void block_copy_call_cancel(BlockCopyCallState *call_state); 98 99 BdrvDirtyBitmap *block_copy_dirty_bitmap(BlockCopyState *s); 100 int64_t block_copy_cluster_size(BlockCopyState *s); 101 void block_copy_set_skip_unallocated(BlockCopyState *s, bool skip); 102 103 #endif /* BLOCK_COPY_H */ 104