ceph/src/librbd/operation/SnapshotRemoveRequest.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_LIBRBD_OPERATION_SNAPSHOT_REMOVE_REQUEST_H
   5 #define CEPH_LIBRBD_OPERATION_SNAPSHOT_REMOVE_REQUEST_H
   6
   7 #include "librbd/operation/Request.h"
   8 #include "include/buffer.h"
   9 #include "librbd/Types.h"
  10 #include <string>
  11
  12 class Context;
  13
  14 namespace librbd {
  15
  16 class ImageCtx;
  17
  18 namespace operation {
  19
  20 template <typename ImageCtxT = ImageCtx>
  21 class SnapshotRemoveRequest : public Request<ImageCtxT> {
  22 public:
  23   /**
  24    * @verbatim
  25    *
  26    * <start>
  27    *    |
  28    *    v
  29    * TRASH_SNAP
  30    *    |
  31    *    v (skip if unsupported)
  32    * GET_SNAP
  33    *    |
  34    *    v (skip if unnecessary)
  35    * LIST_CHILDREN <-------------\
  36    *    |                        |
  37    *    v (skip if unnecessary)  | (repeat as needed)
  38    * DETACH_STALE_CHILD ---------/
  39    *    |
  40    *    v (skip if unnecessary)
  41    * DETACH_CHILD
  42    *    |
  43    *    v (skip if disabled/in-use)
  44    * REMOVE_OBJECT_MAP
  45    *    |
  46    *    v (skip if in-use)
  47    * RELEASE_SNAP_ID
  48    *    |
  49    *    v (skip if in-use)
  50    * REMOVE_SNAP
  51    *    |
  52    *    v
  53    * <finish>
  54    *
  55    * @endverbatim
  56    */
  57
  58   static SnapshotRemoveRequest *create(
  59       ImageCtxT &image_ctx, const cls::rbd::SnapshotNamespace &snap_namespace,
  60       const std::string &snap_name, uint64_t snap_id, Context *on_finish) {
  61     return new SnapshotRemoveRequest(image_ctx, on_finish, snap_namespace,
  62                                      snap_name, snap_id);
  63   }
  64
  65   SnapshotRemoveRequest(ImageCtxT &image_ctx, Context *on_finish,
  66                         const cls::rbd::SnapshotNamespace &snap_namespace,
  67                         const std::string &snap_name,
  68                         uint64_t snap_id);
  69
  70 protected:
  71   void send_op() override;
  72   bool should_complete(int r) override;
  73
  74   journal::Event create_event(uint64_t op_tid) const override {
  75     return journal::SnapRemoveEvent(op_tid, m_snap_namespace, m_snap_name);
  76   }
  77
  78 private:
  79   cls::rbd::SnapshotNamespace m_snap_namespace;
  80   cls::rbd::ChildImageSpecs m_child_images;
  81   std::string m_snap_name;
  82   uint64_t m_snap_id;
  83   bool m_trashed_snapshot = false;
  84   bool m_child_attached = false;
  85
  86   ceph::bufferlist m_out_bl;
  87
  88   void trash_snap();
  89   void handle_trash_snap(int r);
  90
  91   void get_snap();
  92   void handle_get_snap(int r);
  93
  94   void list_children();
  95   void handle_list_children(int r);
  96
  97   void detach_stale_child();
  98   void handle_detach_stale_child(int r);
  99
 100   void detach_child();
 101   void handle_detach_child(int r);
 102
 103   void remove_object_map();
 104   void handle_remove_object_map(int r);
 105
 106   void release_snap_id();
 107   void handle_release_snap_id(int r);
 108
 109   void remove_snap();
 110   void handle_remove_snap(int r);
 111
 112   void remove_snap_context();
 113   int scan_for_parents(cls::rbd::ParentImageSpec &pspec);
 114
 115 };
 116
 117 } // namespace operation
 118 } // namespace librbd
 119
 120 extern template class librbd::operation::SnapshotRemoveRequest<librbd::ImageCtx>;
 121
 122 #endif // CEPH_LIBRBD_OPERATION_SNAPSHOT_REMOVE_REQUEST_H