blob_log_format.cc 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. // Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
  2. // This source code is licensed under both the GPLv2 (found in the
  3. // COPYING file in the root directory) and Apache 2.0 License
  4. // (found in the LICENSE.Apache file in the root directory).
  5. //
  6. #include "db/blob/blob_log_format.h"
  7. #include "util/coding.h"
  8. #include "util/crc32c.h"
  9. namespace ROCKSDB_NAMESPACE {
  10. void BlobLogHeader::EncodeTo(std::string* dst) {
  11. assert(dst != nullptr);
  12. dst->clear();
  13. dst->reserve(BlobLogHeader::kSize);
  14. PutFixed32(dst, kMagicNumber);
  15. PutFixed32(dst, version);
  16. PutFixed32(dst, column_family_id);
  17. unsigned char flags = (has_ttl ? 1 : 0);
  18. dst->push_back(flags);
  19. dst->push_back(compression);
  20. PutFixed64(dst, expiration_range.first);
  21. PutFixed64(dst, expiration_range.second);
  22. }
  23. Status BlobLogHeader::DecodeFrom(Slice src) {
  24. const char* kErrorMessage = "Error while decoding blob log header";
  25. if (src.size() != BlobLogHeader::kSize) {
  26. return Status::Corruption(kErrorMessage,
  27. "Unexpected blob file header size");
  28. }
  29. uint32_t magic_number;
  30. unsigned char flags;
  31. if (!GetFixed32(&src, &magic_number) || !GetFixed32(&src, &version) ||
  32. !GetFixed32(&src, &column_family_id)) {
  33. return Status::Corruption(
  34. kErrorMessage,
  35. "Error decoding magic number, version and column family id");
  36. }
  37. if (magic_number != kMagicNumber) {
  38. return Status::Corruption(kErrorMessage, "Magic number mismatch");
  39. }
  40. if (version != kVersion1) {
  41. return Status::Corruption(kErrorMessage, "Unknown header version");
  42. }
  43. flags = src.data()[0];
  44. compression = static_cast<CompressionType>(src.data()[1]);
  45. has_ttl = (flags & 1) == 1;
  46. src.remove_prefix(2);
  47. if (!GetFixed64(&src, &expiration_range.first) ||
  48. !GetFixed64(&src, &expiration_range.second)) {
  49. return Status::Corruption(kErrorMessage, "Error decoding expiration range");
  50. }
  51. return Status::OK();
  52. }
  53. void BlobLogFooter::EncodeTo(std::string* dst) {
  54. assert(dst != nullptr);
  55. dst->clear();
  56. dst->reserve(BlobLogFooter::kSize);
  57. PutFixed32(dst, kMagicNumber);
  58. PutFixed64(dst, blob_count);
  59. PutFixed64(dst, expiration_range.first);
  60. PutFixed64(dst, expiration_range.second);
  61. crc = crc32c::Value(dst->c_str(), dst->size());
  62. crc = crc32c::Mask(crc);
  63. PutFixed32(dst, crc);
  64. }
  65. Status BlobLogFooter::DecodeFrom(Slice src) {
  66. const char* kErrorMessage = "Error while decoding blob log footer";
  67. if (src.size() != BlobLogFooter::kSize) {
  68. return Status::Corruption(kErrorMessage,
  69. "Unexpected blob file footer size");
  70. }
  71. uint32_t src_crc = 0;
  72. src_crc = crc32c::Value(src.data(), BlobLogFooter::kSize - sizeof(uint32_t));
  73. src_crc = crc32c::Mask(src_crc);
  74. uint32_t magic_number = 0;
  75. if (!GetFixed32(&src, &magic_number) || !GetFixed64(&src, &blob_count) ||
  76. !GetFixed64(&src, &expiration_range.first) ||
  77. !GetFixed64(&src, &expiration_range.second) || !GetFixed32(&src, &crc)) {
  78. return Status::Corruption(kErrorMessage, "Error decoding content");
  79. }
  80. if (magic_number != kMagicNumber) {
  81. return Status::Corruption(kErrorMessage, "Magic number mismatch");
  82. }
  83. if (src_crc != crc) {
  84. return Status::Corruption(kErrorMessage, "CRC mismatch");
  85. }
  86. return Status::OK();
  87. }
  88. void BlobLogRecord::EncodeHeaderTo(std::string* dst) {
  89. assert(dst != nullptr);
  90. dst->clear();
  91. dst->reserve(BlobLogRecord::kHeaderSize + key.size() + value.size());
  92. PutFixed64(dst, key.size());
  93. PutFixed64(dst, value.size());
  94. PutFixed64(dst, expiration);
  95. header_crc = crc32c::Value(dst->c_str(), dst->size());
  96. header_crc = crc32c::Mask(header_crc);
  97. PutFixed32(dst, header_crc);
  98. blob_crc = crc32c::Value(key.data(), key.size());
  99. blob_crc = crc32c::Extend(blob_crc, value.data(), value.size());
  100. blob_crc = crc32c::Mask(blob_crc);
  101. PutFixed32(dst, blob_crc);
  102. }
  103. Status BlobLogRecord::DecodeHeaderFrom(Slice src) {
  104. const char* kErrorMessage = "Error while decoding blob record";
  105. if (src.size() != BlobLogRecord::kHeaderSize) {
  106. return Status::Corruption(kErrorMessage,
  107. "Unexpected blob record header size");
  108. }
  109. uint32_t src_crc = 0;
  110. src_crc = crc32c::Value(src.data(), BlobLogRecord::kHeaderSize - 8);
  111. src_crc = crc32c::Mask(src_crc);
  112. if (!GetFixed64(&src, &key_size) || !GetFixed64(&src, &value_size) ||
  113. !GetFixed64(&src, &expiration) || !GetFixed32(&src, &header_crc) ||
  114. !GetFixed32(&src, &blob_crc)) {
  115. return Status::Corruption(kErrorMessage, "Error decoding content");
  116. }
  117. if (src_crc != header_crc) {
  118. return Status::Corruption(kErrorMessage, "Header CRC mismatch");
  119. }
  120. return Status::OK();
  121. }
  122. Status BlobLogRecord::CheckBlobCRC() const {
  123. uint32_t expected_crc = 0;
  124. expected_crc = crc32c::Value(key.data(), key.size());
  125. expected_crc = crc32c::Extend(expected_crc, value.data(), value.size());
  126. expected_crc = crc32c::Mask(expected_crc);
  127. if (expected_crc != blob_crc) {
  128. return Status::Corruption("Blob CRC mismatch");
  129. }
  130. return Status::OK();
  131. }
  132. } // namespace ROCKSDB_NAMESPACE