1 files changed, 64 insertions, 3 deletions

diff --git a/src/rgw/rgw_bucket_logging.h b/src/rgw/rgw_bucket_logging.h
index d4877bafb0f..cbdb8b55f88 100644
--- a/src/rgw/rgw_bucket_logging.h
+++ b/src/rgw/rgw_bucket_logging.h
@@ -4,7 +4,6 @@
 #pragma once
 
 #include <string>
-#include <optional>
 #include <cstdint>
 #include "rgw_sal_fwd.h"
 #include "include/buffer.h"
@@ -16,7 +15,7 @@ class XMLObj;
 namespace ceph { class Formatter; }
 class DoutPrefixProvider;
 struct req_state;
-class RGWObjVersionTracker;
+struct RGWObjVersionTracker;
 class RGWOp;
 
 namespace rgw::bucketlogging {
@@ -66,6 +65,17 @@ enum class LoggingType {Standard, Journal, Any};
 enum class PartitionDateSource {DeliveryTime, EventTime};
 
 struct configuration {
+  bool operator==(const configuration& rhs) const {
+    return enabled == rhs.enabled &&
+           target_bucket == rhs.target_bucket &&
+           obj_key_format == rhs.obj_key_format &&
+           target_prefix == rhs.target_prefix &&
+           obj_roll_time == rhs.obj_roll_time &&
+           logging_type == rhs.logging_type &&
+           records_batch_size == rhs.records_batch_size &&
+           date_source == rhs.date_source &&
+           key_filter == rhs.key_filter;
+  }
   uint32_t default_obj_roll_time = 300;
   bool enabled = false;
   std::string target_bucket;
@@ -129,6 +139,8 @@ struct configuration {
 };
 WRITE_CLASS_ENCODER(configuration)
 
+using source_buckets = std::set<rgw_bucket>;
+
 constexpr unsigned MAX_BUCKET_LOGGING_BUFFER = 1000;
 
 using bucket_logging_records = std::array<std::string, MAX_BUCKET_LOGGING_BUFFER>;
@@ -155,7 +167,7 @@ int log_record(rgw::sal::Driver* driver,
     bool async_completion,
     bool log_source_bucket);
 
-// commit the pending log objec tto the log bucket
+// commit the pending log objec to the log bucket
 // and create a new pending log object
 // if "must_commit" is "false" the function will return success even if the pending log object was not committed
 int rollover_logging_object(const configuration& conf,
@@ -166,6 +178,23 @@ int rollover_logging_object(const configuration& conf,
     bool must_commit,
     RGWObjVersionTracker* objv_tracker);
 
+// commit the pending log object to the log bucket
+// use this for cleanup, when new pending object is not needed
+// and target bucket is known
+int commit_logging_object(const configuration& conf,
+    const std::unique_ptr<rgw::sal::Bucket>& target_bucket,
+    const DoutPrefixProvider *dpp,
+    optional_yield y);
+
+// commit the pending log object to the log bucket
+// use this for cleanup, when new pending object is not needed
+// and target bucket shoud be loaded based on the configuration
+int commit_logging_object(const configuration& conf,
+    const DoutPrefixProvider *dpp,
+    rgw::sal::Driver* driver,
+    const std::string& tenant_name,
+    optional_yield y);
+
 // return the oid of the object holding the name of the temporary logging object
 // bucket - log bucket
 // prefix - logging prefix from configuration. should be used when multiple buckets log into the same log bucket
@@ -185,5 +214,37 @@ int log_record(rgw::sal::Driver* driver,
     optional_yield y, 
     bool async_completion,
     bool log_source_bucket);
+
+// return (by ref) an rgw_bucket object with the bucket name and tenant name
+// fails if the bucket name is not in the format: [tenant name:]<bucket name>
+int get_bucket_id(const std::string& bucket_name, const std::string& tenant_name, rgw_bucket& bucket_id);
+
+// update (add or remove) a source bucket from the list of source buckets in the target bucket
+// use this function when the target bucket is already loaded
+int update_bucket_logging_sources(const DoutPrefixProvider* dpp, std::unique_ptr<rgw::sal::Bucket>& bucket, 
+    const rgw_bucket& src_bucket, bool add, optional_yield y);
+
+// update (add or remove) a source bucket from the list of source buckets in the target bucket
+// use this function when the target bucket is not known and needs to be loaded
+int update_bucket_logging_sources(const DoutPrefixProvider* dpp, rgw::sal::Driver* driver, const rgw_bucket& target_bucket_id, 
+    const rgw_bucket& src_bucket_id, bool add, optional_yield y);
+
+// when source bucket is deleted, all pending log objects should be comitted to the log bucket
+// when the target bucket is deleted, all pending log objects should be deleted, as well as the object holding the pending log object name
+int bucket_deletion_cleanup(const DoutPrefixProvider* dpp,
+                                   sal::Driver* driver,
+                                   sal::Bucket* bucket,
+                                   optional_yield y);
+
+// if bucket has bucket logging configuration associated with it then:
+// if "remove_attr" is true, the bucket logging configuration should be removed from the bucket
+// in addition:
+// any pending log objects should be comitted to the log bucket
+// and the log bucket should be updated to remove the bucket as a source
+int source_bucket_cleanup(const DoutPrefixProvider* dpp,
+                                   sal::Driver* driver,
+                                   sal::Bucket* bucket,
+                                   bool remove_attr,
+                                   optional_yield y);
 } // namespace rgw::bucketlogging