summaryrefslogtreecommitdiffstats
path: root/src/rocksdb/db/blob/blob_file_garbage.cc
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/rocksdb/db/blob/blob_file_garbage.cc134
1 files changed, 134 insertions, 0 deletions
diff --git a/src/rocksdb/db/blob/blob_file_garbage.cc b/src/rocksdb/db/blob/blob_file_garbage.cc
new file mode 100644
index 000000000..52c336f49
--- /dev/null
+++ b/src/rocksdb/db/blob/blob_file_garbage.cc
@@ -0,0 +1,134 @@
+// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
+// This source code is licensed under both the GPLv2 (found in the
+// COPYING file in the root directory) and Apache 2.0 License
+// (found in the LICENSE.Apache file in the root directory).
+
+#include "db/blob/blob_file_garbage.h"
+
+#include <ostream>
+#include <sstream>
+
+#include "logging/event_logger.h"
+#include "rocksdb/slice.h"
+#include "rocksdb/status.h"
+#include "test_util/sync_point.h"
+#include "util/coding.h"
+
+namespace ROCKSDB_NAMESPACE {
+
+// Tags for custom fields. Note that these get persisted in the manifest,
+// so existing tags should not be modified.
+enum BlobFileGarbage::CustomFieldTags : uint32_t {
+ kEndMarker,
+
+ // Add forward compatible fields here
+
+ /////////////////////////////////////////////////////////////////////
+
+ kForwardIncompatibleMask = 1 << 6,
+
+ // Add forward incompatible fields here
+};
+
+void BlobFileGarbage::EncodeTo(std::string* output) const {
+ PutVarint64(output, blob_file_number_);
+ PutVarint64(output, garbage_blob_count_);
+ PutVarint64(output, garbage_blob_bytes_);
+
+ // Encode any custom fields here. The format to use is a Varint32 tag (see
+ // CustomFieldTags above) followed by a length prefixed slice. Unknown custom
+ // fields will be ignored during decoding unless they're in the forward
+ // incompatible range.
+
+ TEST_SYNC_POINT_CALLBACK("BlobFileGarbage::EncodeTo::CustomFields", output);
+
+ PutVarint32(output, kEndMarker);
+}
+
+Status BlobFileGarbage::DecodeFrom(Slice* input) {
+ constexpr char class_name[] = "BlobFileGarbage";
+
+ if (!GetVarint64(input, &blob_file_number_)) {
+ return Status::Corruption(class_name, "Error decoding blob file number");
+ }
+
+ if (!GetVarint64(input, &garbage_blob_count_)) {
+ return Status::Corruption(class_name, "Error decoding garbage blob count");
+ }
+
+ if (!GetVarint64(input, &garbage_blob_bytes_)) {
+ return Status::Corruption(class_name, "Error decoding garbage blob bytes");
+ }
+
+ while (true) {
+ uint32_t custom_field_tag = 0;
+ if (!GetVarint32(input, &custom_field_tag)) {
+ return Status::Corruption(class_name, "Error decoding custom field tag");
+ }
+
+ if (custom_field_tag == kEndMarker) {
+ break;
+ }
+
+ if (custom_field_tag & kForwardIncompatibleMask) {
+ return Status::Corruption(
+ class_name, "Forward incompatible custom field encountered");
+ }
+
+ Slice custom_field_value;
+ if (!GetLengthPrefixedSlice(input, &custom_field_value)) {
+ return Status::Corruption(class_name,
+ "Error decoding custom field value");
+ }
+ }
+
+ return Status::OK();
+}
+
+std::string BlobFileGarbage::DebugString() const {
+ std::ostringstream oss;
+
+ oss << *this;
+
+ return oss.str();
+}
+
+std::string BlobFileGarbage::DebugJSON() const {
+ JSONWriter jw;
+
+ jw << *this;
+
+ jw.EndObject();
+
+ return jw.Get();
+}
+
+bool operator==(const BlobFileGarbage& lhs, const BlobFileGarbage& rhs) {
+ return lhs.GetBlobFileNumber() == rhs.GetBlobFileNumber() &&
+ lhs.GetGarbageBlobCount() == rhs.GetGarbageBlobCount() &&
+ lhs.GetGarbageBlobBytes() == rhs.GetGarbageBlobBytes();
+}
+
+bool operator!=(const BlobFileGarbage& lhs, const BlobFileGarbage& rhs) {
+ return !(lhs == rhs);
+}
+
+std::ostream& operator<<(std::ostream& os,
+ const BlobFileGarbage& blob_file_garbage) {
+ os << "blob_file_number: " << blob_file_garbage.GetBlobFileNumber()
+ << " garbage_blob_count: " << blob_file_garbage.GetGarbageBlobCount()
+ << " garbage_blob_bytes: " << blob_file_garbage.GetGarbageBlobBytes();
+
+ return os;
+}
+
+JSONWriter& operator<<(JSONWriter& jw,
+ const BlobFileGarbage& blob_file_garbage) {
+ jw << "BlobFileNumber" << blob_file_garbage.GetBlobFileNumber()
+ << "GarbageBlobCount" << blob_file_garbage.GetGarbageBlobCount()
+ << "GarbageBlobBytes" << blob_file_garbage.GetGarbageBlobBytes();
+
+ return jw;
+}
+
+} // namespace ROCKSDB_NAMESPACE