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