ceph/src/tools/rbd/Utils.h

   1 // -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
   2 // vim: ts=8 sw=2 smarttab
   3
   4 #ifndef CEPH_RBD_UTILS_H
   5 #define CEPH_RBD_UTILS_H
   6
   7 #include "include/int_types.h"
   8 #include "include/rados/librados.hpp"
   9 #include "include/rbd/librbd.hpp"
  10 #include "tools/rbd/ArgumentTypes.h"
  11 #include <map>
  12 #include <string>
  13 #include <boost/program_options.hpp>
  14
  15 namespace rbd {
  16 namespace utils {
  17
  18 namespace detail {
  19
  20 template <typename T, void(T::*MF)(int)>
  21 void aio_completion_callback(librbd::completion_t completion,
  22                                     void *arg) {
  23   librbd::RBD::AioCompletion *aio_completion =
  24     reinterpret_cast<librbd::RBD::AioCompletion*>(completion);
  25
  26   // complete the AIO callback in separate thread context
  27   T *t = reinterpret_cast<T *>(arg);
  28   int r = aio_completion->get_return_value();
  29   aio_completion->release();
  30
  31   (t->*MF)(r);
  32 }
  33
  34 } // namespace detail
  35
  36 static const std::string RBD_DIFF_BANNER ("rbd diff v1\n");
  37 static const size_t RBD_DEFAULT_SPARSE_SIZE = 4096;
  38
  39 static const std::string RBD_IMAGE_BANNER_V2 ("rbd image v2\n");
  40 static const std::string RBD_IMAGE_DIFFS_BANNER_V2 ("rbd image diffs v2\n");
  41 static const std::string RBD_DIFF_BANNER_V2 ("rbd diff v2\n");
  42
  43 #define RBD_DIFF_FROM_SNAP      'f'
  44 #define RBD_DIFF_TO_SNAP        't'
  45 #define RBD_DIFF_IMAGE_SIZE     's'
  46 #define RBD_DIFF_WRITE          'w'
  47 #define RBD_DIFF_ZERO           'z'
  48 #define RBD_DIFF_END            'e'
  49
  50 #define RBD_SNAP_PROTECTION_STATUS     'p'
  51
  52 #define RBD_EXPORT_IMAGE_ORDER          'O'
  53 #define RBD_EXPORT_IMAGE_FEATURES       'T'
  54 #define RBD_EXPORT_IMAGE_STRIPE_UNIT    'U'
  55 #define RBD_EXPORT_IMAGE_STRIPE_COUNT   'C'
  56 #define RBD_EXPORT_IMAGE_META           'M'
  57 #define RBD_EXPORT_IMAGE_END            'E'
  58
  59 enum SnapshotPresence {
  60   SNAPSHOT_PRESENCE_NONE,
  61   SNAPSHOT_PRESENCE_PERMITTED,
  62   SNAPSHOT_PRESENCE_REQUIRED
  63 };
  64
  65 enum SpecValidation {
  66   SPEC_VALIDATION_FULL,
  67   SPEC_VALIDATION_SNAP,
  68   SPEC_VALIDATION_NONE
  69 };
  70
  71 struct ProgressContext : public librbd::ProgressContext {
  72   const char *operation;
  73   bool progress;
  74   int last_pc;
  75
  76   ProgressContext(const char *o, bool no_progress)
  77     : operation(o), progress(!no_progress), last_pc(0) {
  78   }
  79
  80   int update_progress(uint64_t offset, uint64_t total) override;
  81   void finish();
  82   void fail();
  83 };
  84
  85 template <typename T, void(T::*MF)(int)>
  86 librbd::RBD::AioCompletion *create_aio_completion(T *t) {
  87   return new librbd::RBD::AioCompletion(
  88     t, &detail::aio_completion_callback<T, MF>);
  89 }
  90
  91 void aio_context_callback(librbd::completion_t completion, void *arg);
  92
  93 int read_string(int fd, unsigned max, std::string *out);
  94
  95 int extract_spec(const std::string &spec, std::string *pool_name,
  96                  std::string *namespace_name, std::string *name,
  97                  std::string *snap_name, SpecValidation spec_validation);
  98
  99 std::string get_positional_argument(
 100     const boost::program_options::variables_map &vm, size_t index);
 101
 102 void normalize_pool_name(std::string* pool_name);
 103 std::string get_default_pool_name();
 104
 105 int get_pool_and_namespace_names(
 106     const boost::program_options::variables_map &vm,
 107     bool default_empty_pool_name, bool validate_pool_name,
 108     std::string* pool_name, std::string* namespace_name, size_t *arg_index);
 109
 110 int get_pool_image_snapshot_names(
 111     const boost::program_options::variables_map &vm,
 112     argument_types::ArgumentModifier mod, size_t *spec_arg_index,
 113     std::string *pool_name, std::string *namespace_name,
 114     std::string *image_name, std::string *snap_name, bool image_name_required,
 115     SnapshotPresence snapshot_presence, SpecValidation spec_validation);
 116
 117 int get_pool_generic_snapshot_names(
 118     const boost::program_options::variables_map &vm,
 119     argument_types::ArgumentModifier mod, size_t *spec_arg_index,
 120     const std::string& pool_key, std::string *pool_name,
 121     std::string *namespace_name, const std::string& generic_key,
 122     const std::string& generic_key_desc, std::string *generic_name,
 123     std::string *snap_name, bool generic_name_required,
 124     SnapshotPresence snapshot_presence, SpecValidation spec_validation);
 125
 126 int get_pool_image_id(const boost::program_options::variables_map &vm,
 127                       size_t *spec_arg_index,
 128                       std::string *pool_name,
 129                       std::string *namespace_name,
 130                       std::string *image_id);
 131
 132 int validate_snapshot_name(argument_types::ArgumentModifier mod,
 133                            const std::string &snap_name,
 134                            SnapshotPresence snapshot_presence,
 135                            SpecValidation spec_validation);
 136
 137 int get_image_options(const boost::program_options::variables_map &vm,
 138                       bool get_format, librbd::ImageOptions* opts);
 139
 140 int get_journal_options(const boost::program_options::variables_map &vm,
 141                         librbd::ImageOptions *opts);
 142
 143 int get_flatten_option(const boost::program_options::variables_map &vm,
 144                        librbd::ImageOptions *opts);
 145
 146 int get_image_size(const boost::program_options::variables_map &vm,
 147                    uint64_t *size);
 148
 149 int get_path(const boost::program_options::variables_map &vm,
 150              size_t *arg_index, std::string *path);
 151
 152 int get_formatter(const boost::program_options::variables_map &vm,
 153                   argument_types::Format::Formatter *formatter);
 154
 155 int get_snap_create_flags(const boost::program_options::variables_map &vm,
 156                           uint32_t *flags);
 157
 158 void init_context();
 159
 160 int init_rados(librados::Rados *rados);
 161
 162 int init(const std::string& pool_name, const std::string& namespace_name,
 163          librados::Rados *rados, librados::IoCtx *io_ctx);
 164 int init_io_ctx(librados::Rados &rados, std::string pool_name,
 165                 const std::string& namespace_name, librados::IoCtx *io_ctx);
 166 int set_namespace(const std::string& namespace_name, librados::IoCtx *io_ctx);
 167
 168 void disable_cache();
 169
 170 int open_image(librados::IoCtx &io_ctx, const std::string &image_name,
 171                bool read_only, librbd::Image *image);
 172
 173 int open_image_by_id(librados::IoCtx &io_ctx, const std::string &image_id,
 174                      bool read_only, librbd::Image *image);
 175
 176 int init_and_open_image(const std::string &pool_name,
 177                         const std::string &namespace_name,
 178                         const std::string &image_name,
 179                         const std::string &image_id,
 180                         const std::string &snap_name, bool read_only,
 181                         librados::Rados *rados, librados::IoCtx *io_ctx,
 182                         librbd::Image *image);
 183
 184 int snap_set(librbd::Image &image, const std::string &snap_name);
 185
 186 void calc_sparse_extent(const bufferptr &bp,
 187                         size_t sparse_size,
 188                         size_t buffer_offset,
 189                         uint64_t length,
 190                         size_t *write_length,
 191                         bool *zeroed);
 192
 193 bool is_not_user_snap_namespace(librbd::Image* image,
 194                                 const librbd::snap_info_t &snap_info);
 195
 196 std::string image_id(librbd::Image& image);
 197
 198 std::string mirror_image_mode(
 199     librbd::mirror_image_mode_t mirror_image_mode);
 200 std::string mirror_image_state(
 201     librbd::mirror_image_state_t mirror_image_state);
 202 std::string mirror_image_status_state(
 203     librbd::mirror_image_status_state_t state);
 204 std::string mirror_image_site_status_state(
 205     const librbd::mirror_image_site_status_t& status);
 206 std::string mirror_image_global_status_state(
 207     const librbd::mirror_image_global_status_t& status);
 208
 209 int get_local_mirror_image_status(
 210     const librbd::mirror_image_global_status_t& status,
 211     librbd::mirror_image_site_status_t* local_status);
 212
 213 std::string timestr(time_t t);
 214
 215 // duplicate here to not include librbd_internal lib
 216 uint64_t get_rbd_default_features(CephContext* cct);
 217
 218 void get_mirror_peer_sites(
 219     librados::IoCtx& io_ctx,
 220     std::vector<librbd::mirror_peer_site_t>* mirror_peers);
 221 void get_mirror_peer_mirror_uuids_to_names(
 222     const std::vector<librbd::mirror_peer_site_t>& mirror_peers,
 223     std::map<std::string, std::string>* fsid_to_name);
 224 void populate_unknown_mirror_image_site_statuses(
 225     const std::vector<librbd::mirror_peer_site_t>& mirror_peers,
 226     librbd::mirror_image_global_status_t* global_status);
 227
 228 int mgr_command(librados::Rados& rados, const std::string& cmd,
 229                 const std::map<std::string, std::string> &args,
 230                 std::ostream *out_os, std::ostream *err_os);
 231
 232 } // namespace utils
 233 } // namespace rbd
 234
 235 #endif // CEPH_RBD_UTILS_H