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.h" 19 #include "qemu/co-shared-resource.h" 20 21 typedef void (*BlockCopyAsyncCallbackFunc)(void *opaque); 22 typedef struct BlockCopyState BlockCopyState; 23 typedef struct BlockCopyCallState BlockCopyCallState; 24 25 BlockCopyState *block_copy_state_new(BdrvChild *source, BdrvChild *target, 26 int64_t cluster_size, bool use_copy_range, 27 BdrvRequestFlags write_flags, 28 Error **errp); 29 30 void block_copy_set_progress_meter(BlockCopyState *s, ProgressMeter *pm); 31 32 void block_copy_state_free(BlockCopyState *s); 33 34 int64_t block_copy_reset_unallocated(BlockCopyState *s, 35 int64_t offset, int64_t *count); 36 37 int coroutine_fn block_copy(BlockCopyState *s, int64_t offset, int64_t bytes, 38 bool ignore_ratelimit); 39 40 /* 41 * Run block-copy in a coroutine, create corresponding BlockCopyCallState 42 * object and return pointer to it. Never returns NULL. 43 * 44 * Caller is responsible to call block_copy_call_free() to free 45 * BlockCopyCallState object. 46 * 47 * @max_workers means maximum of parallel coroutines to execute sub-requests, 48 * must be > 0. 49 * 50 * @max_chunk means maximum length for one IO operation. Zero means unlimited. 51 */ 52 BlockCopyCallState *block_copy_async(BlockCopyState *s, 53 int64_t offset, int64_t bytes, 54 int max_workers, int64_t max_chunk, 55 BlockCopyAsyncCallbackFunc cb, 56 void *cb_opaque); 57 58 /* 59 * Free finished BlockCopyCallState. Trying to free running 60 * block-copy will crash. 61 */ 62 void block_copy_call_free(BlockCopyCallState *call_state); 63 64 /* 65 * Note, that block-copy call is marked finished prior to calling 66 * the callback. 67 */ 68 bool block_copy_call_finished(BlockCopyCallState *call_state); 69 bool block_copy_call_succeeded(BlockCopyCallState *call_state); 70 bool block_copy_call_failed(BlockCopyCallState *call_state); 71 bool block_copy_call_cancelled(BlockCopyCallState *call_state); 72 int block_copy_call_status(BlockCopyCallState *call_state, bool *error_is_read); 73 74 void block_copy_set_speed(BlockCopyState *s, uint64_t speed); 75 void block_copy_kick(BlockCopyCallState *call_state); 76 77 /* 78 * Cancel running block-copy call. 79 * 80 * Cancel leaves block-copy state valid: dirty bits are correct and you may use 81 * cancel + <run block_copy with same parameters> to emulate pause/resume. 82 * 83 * Note also, that the cancel is async: it only marks block-copy call to be 84 * cancelled. So, the call may be cancelled (block_copy_call_cancelled() reports 85 * true) but not yet finished (block_copy_call_finished() reports false). 86 */ 87 void block_copy_call_cancel(BlockCopyCallState *call_state); 88 89 BdrvDirtyBitmap *block_copy_dirty_bitmap(BlockCopyState *s); 90 void block_copy_set_skip_unallocated(BlockCopyState *s, bool skip); 91 92 #endif /* BLOCK_COPY_H */ 93