import ceph quincy 17.2.6

[ceph.git] / ceph / src / rgw / rgw_gc.h

// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
// vim: ts=8 sw=2 smarttab ft=cpp

#ifndef CEPH_RGW_GC_H
#define CEPH_RGW_GC_H


#include "include/types.h"
#include "include/rados/librados.hpp"
#include "common/ceph_mutex.h"
#include "common/Cond.h"
#include "common/Thread.h"
#include "rgw_common.h"
#include "rgw_sal.h"
#include "rgw_rados.h"
#include "cls/rgw/cls_rgw_types.h"

#include <atomic>

class RGWGCIOManager;

class RGWGC : public DoutPrefixProvider {
  CephContext *cct;
  RGWRados *store;
  int max_objs;
  std::string *obj_names;
  std::atomic<bool> down_flag = { false };

  static constexpr uint64_t seed = 8675309;

  int tag_index(const std::string& tag);
  int send_chain(const cls_rgw_obj_chain& chain, const std::string& tag);

  class GCWorker : public Thread {
    const DoutPrefixProvider *dpp;
    CephContext *cct;
    RGWGC *gc;
    ceph::mutex lock = ceph::make_mutex("GCWorker");
    ceph::condition_variable cond;

  public:
    GCWorker(const DoutPrefixProvider *_dpp, CephContext *_cct, RGWGC *_gc) : dpp(_dpp), cct(_cct), gc(_gc) {}
    void *entry() override;
    void stop();
  };

  GCWorker *worker;
public:
  RGWGC() : cct(NULL), store(NULL), max_objs(0), obj_names(NULL), worker(NULL) {}
  ~RGWGC() {
    stop_processor();
    finalize();
  }
  std::vector<bool> transitioned_objects_cache;
  std::tuple<int, std::optional<cls_rgw_obj_chain>> send_split_chain(const cls_rgw_obj_chain& chain, const std::string& tag);

  // asynchronously defer garbage collection on an object that's still being read
  int async_defer_chain(const std::string& tag, const cls_rgw_obj_chain& info);

  // callback for when async_defer_chain() fails with ECANCELED
  void on_defer_canceled(const cls_rgw_gc_obj_info& info);

  int remove(int index, const std::vector<std::string>& tags, librados::AioCompletion **pc);
  int remove(int index, int num_entries);

  void initialize(CephContext *_cct, RGWRados *_store);
  void finalize();

  int list(int *index, std::string& marker, uint32_t max, bool expired_only, std::list<cls_rgw_gc_obj_info>& result, bool *truncated, bool& processing_queue);
  void list_init(int *index) { *index = 0; }
  int process(int index, int process_max_secs, bool expired_only,
              RGWGCIOManager& io_manager);
  int process(bool expired_only);

  bool going_down();
  void start_processor();
  void stop_processor();

  CephContext *get_cct() const override { return store->ctx(); }
  unsigned get_subsys() const;

  std::ostream& gen_prefix(std::ostream& out) const;

};


#endif