include/block/block-copy.h

   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                                      uint64_t min_cluster_size,
  32                                      Error **errp);
  33
  34 /* Function should be called prior any actual copy request */
  35 void block_copy_set_copy_opts(BlockCopyState *s, bool use_copy_range,
  36                               bool compress);
  37 void block_copy_set_progress_meter(BlockCopyState *s, ProgressMeter *pm);
  38
  39 void block_copy_state_free(BlockCopyState *s);
  40
  41 void block_copy_reset(BlockCopyState *s, int64_t offset, int64_t bytes);
  42
  43 int64_t coroutine_fn GRAPH_RDLOCK
  44 block_copy_reset_unallocated(BlockCopyState *s, int64_t offset, int64_t *count);
  45
  46 int coroutine_fn block_copy(BlockCopyState *s, int64_t offset, int64_t bytes,
  47                             bool ignore_ratelimit, uint64_t timeout_ns,
  48                             BlockCopyAsyncCallbackFunc cb,
  49                             void *cb_opaque);
  50
  51 /*
  52  * Run block-copy in a coroutine, create corresponding BlockCopyCallState
  53  * object and return pointer to it. Never returns NULL.
  54  *
  55  * Caller is responsible to call block_copy_call_free() to free
  56  * BlockCopyCallState object.
  57  *
  58  * @max_workers means maximum of parallel coroutines to execute sub-requests,
  59  * must be > 0.
  60  *
  61  * @max_chunk means maximum length for one IO operation. Zero means unlimited.
  62  */
  63 BlockCopyCallState *block_copy_async(BlockCopyState *s,
  64                                      int64_t offset, int64_t bytes,
  65                                      int max_workers, int64_t max_chunk,
  66                                      BlockCopyAsyncCallbackFunc cb,
  67                                      void *cb_opaque);
  68
  69 /*
  70  * Free finished BlockCopyCallState. Trying to free running
  71  * block-copy will crash.
  72  */
  73 void block_copy_call_free(BlockCopyCallState *call_state);
  74
  75 /*
  76  * Note, that block-copy call is marked finished prior to calling
  77  * the callback.
  78  */
  79 bool block_copy_call_finished(BlockCopyCallState *call_state);
  80 bool block_copy_call_succeeded(BlockCopyCallState *call_state);
  81 bool block_copy_call_failed(BlockCopyCallState *call_state);
  82 bool block_copy_call_cancelled(BlockCopyCallState *call_state);
  83 int block_copy_call_status(BlockCopyCallState *call_state, bool *error_is_read);
  84
  85 void block_copy_set_speed(BlockCopyState *s, uint64_t speed);
  86 void block_copy_kick(BlockCopyCallState *call_state);
  87
  88 /*
  89  * Cancel running block-copy call.
  90  *
  91  * Cancel leaves block-copy state valid: dirty bits are correct and you may use
  92  * cancel + <run block_copy with same parameters> to emulate pause/resume.
  93  *
  94  * Note also, that the cancel is async: it only marks block-copy call to be
  95  * cancelled. So, the call may be cancelled (block_copy_call_cancelled() reports
  96  * true) but not yet finished (block_copy_call_finished() reports false).
  97  */
  98 void block_copy_call_cancel(BlockCopyCallState *call_state);
  99
 100 BdrvDirtyBitmap *block_copy_dirty_bitmap(BlockCopyState *s);
 101 int64_t block_copy_cluster_size(BlockCopyState *s);
 102 void block_copy_set_skip_unallocated(BlockCopyState *s, bool skip);
 103
 104 #endif /* BLOCK_COPY_H */