YugabyteDB (2.13.0.0-b42, bfc6a6643e7399ac8a0e81d06a3ee6d6571b33ab)

//  Copyright (c) 2011-present, Facebook, Inc.  All rights reserved.

//  This source code is licensed under the BSD-style license found in the

//  LICENSE file in the root directory of this source tree. An additional grant

//  of patent rights can be found in the PATENTS file in the same directory.

//

// The following only applies to changes made to this file as part of YugaByte development.

//

// Portions Copyright (c) YugaByte, Inc.

//

// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except

// in compliance with the License.  You may obtain a copy of the License at

//

// http://www.apache.org/licenses/LICENSE-2.0

//

// Unless required by applicable law or agreed to in writing, software distributed under the License

// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express

// or implied.  See the License for the specific language governing permissions and limitations

// under the License.

//

#include "yb/rocksdb/table/meta_blocks.h"

#include <map>

#include <string>

#include "yb/rocksdb/db/table_properties_collector.h"

#include "yb/rocksdb/table.h"

#include "yb/rocksdb/table/block.h"

#include "yb/rocksdb/table/block_builder.h"

#include "yb/rocksdb/table/format.h"

#include "yb/rocksdb/table/internal_iterator.h"

#include "yb/rocksdb/table/table_properties_internal.h"

#include "yb/rocksdb/util/coding.h"

#include "yb/rocksdb/util/file_reader_writer.h"

DEFINE_bool(verify_encrypted_meta_block_checksums, true,

            "Whether to verify checksums for meta blocks of encrypted SSTables.");

namespace rocksdb {

namespace {

constexpr auto kMetaIndexBlockRestartInterval = 1;

// We use kKeyDeltaEncodingSharedPrefix format for property blocks, but since

// kPropertyBlockRestartInterval == 1 every key in these blocks will still have zero shared prefix

// length and will be stored fully.

constexpr auto kPropertyBlockKeyValueEncodingFormat =

    KeyValueEncodingFormat::kKeyDeltaEncodingSharedPrefix;

constexpr auto kPropertyBlockRestartInterval = 1;

ReadOptions CreateMetaBlockReadOptions(RandomAccessFileReader* file) {

  ReadOptions read_options;

  // We need to verify checksums for meta blocks in order to recover from the encryption format

  // issue described at https://github.com/yugabyte/yugabyte-db/issues/3707.

  // However, we only do that for encrypted files in order to prevent lots of RocksDB unit tests

  // from failing as described at https://github.com/yugabyte/yugabyte-db/issues/3974.

  read_options.verify_checksums = file->file()->IsEncrypted() &&

                                  FLAGS_verify_encrypted_meta_block_checksums;

  return read_options;

}

}  // namespace

MetaIndexBuilder::MetaIndexBuilder()

    : meta_index_block_(new BlockBuilder(

          kMetaIndexBlockRestartInterval, kMetaIndexBlockKeyValueEncodingFormat)) {}

void MetaIndexBuilder::Add(const std::string& key,

                           const BlockHandle& handle) {

  std::string handle_encoding;

  handle.AppendEncodedTo(&handle_encoding);

  meta_block_handles_.insert({key, handle_encoding});

}

Slice MetaIndexBuilder::Finish() {

  for (const auto& metablock : meta_block_handles_) {

    meta_index_block_->Add(metablock.first, metablock.second);

  }

  return meta_index_block_->Finish();

}

PropertyBlockBuilder::PropertyBlockBuilder()

    : properties_block_(

          new BlockBuilder(kPropertyBlockRestartInterval, kPropertyBlockKeyValueEncodingFormat)) {}

void PropertyBlockBuilder::Add(const std::string& name,

                               const std::string& val) {

  props_.insert({name, val});

}

void PropertyBlockBuilder::Add(const std::string& name, uint64_t val) {

  assert(props_.find(name) == props_.end());

  std::string dst;

  PutVarint64(&dst, val);

  Add(name, dst);

}

void PropertyBlockBuilder::Add(

    const UserCollectedProperties& user_collected_properties) {

  for (const auto& prop : user_collected_properties) {

    Add(prop.first, prop.second);

  }

}

void PropertyBlockBuilder::AddTableProperty(const TableProperties& props) {

  Add(TablePropertiesNames::kRawKeySize, props.raw_key_size);

  Add(TablePropertiesNames::kRawValueSize, props.raw_value_size);

  Add(TablePropertiesNames::kDataSize, props.data_size);

  Add(TablePropertiesNames::kDataIndexSize, props.data_index_size);

  Add(TablePropertiesNames::kFilterIndexSize, props.filter_index_size);

  Add(TablePropertiesNames::kNumEntries, props.num_entries);

  Add(TablePropertiesNames::kNumDataBlocks, props.num_data_blocks);

  Add(TablePropertiesNames::kNumFilterBlocks, props.num_filter_blocks);

  Add(TablePropertiesNames::kNumDataIndexBlocks, props.num_data_index_blocks);

  Add(TablePropertiesNames::kFilterSize, props.filter_size);

  Add(TablePropertiesNames::kFormatVersion, props.format_version);

  Add(TablePropertiesNames::kFixedKeyLen, props.fixed_key_len);

  if (!props.filter_policy_name.empty()) {

    Add(TablePropertiesNames::kFilterPolicy,

        props.filter_policy_name);

  }

}

Slice PropertyBlockBuilder::Finish() {

  for (const auto& prop : props_) {

    properties_block_->Add(prop.first, prop.second);

  }

  return properties_block_->Finish();

}

void LogPropertiesCollectionError(

    Logger* info_log, const std::string& method, const std::string& name) {

  assert(method == "Add" || method == "Finish");

  std::string msg =

    "Encountered error when calling TablePropertiesCollector::" +

    method + "() with collector name: " + name;

  RLOG(InfoLogLevel::ERROR_LEVEL, info_log, "%s", msg.c_str());

}

bool NotifyCollectTableCollectorsOnAdd(

    const Slice& key, const Slice& value, uint64_t file_size,

    const std::vector<std::unique_ptr<IntTblPropCollector>>& collectors,

    Logger* info_log) {

  bool all_succeeded = true;

  for (auto& collector : collectors) {

    Status s = collector->InternalAdd(key, value, file_size);

    all_succeeded = all_succeeded && s.ok();

    if (!s.ok()) {

      LogPropertiesCollectionError(info_log, "Add" /* method */,

                                   collector->Name());

    }

  }

  return all_succeeded;

}

bool NotifyCollectTableCollectorsOnFinish(

    const std::vector<std::unique_ptr<IntTblPropCollector>>& collectors,

    Logger* info_log, PropertyBlockBuilder* builder) {

  bool all_succeeded = true;

  for (auto& collector : collectors) {

    UserCollectedProperties user_collected_properties;

    Status s = collector->Finish(&user_collected_properties);

    all_succeeded = all_succeeded && s.ok();

    if (!s.ok()) {

      LogPropertiesCollectionError(info_log, "Finish" /* method */,

                                   collector->Name());

    } else {

      builder->Add(user_collected_properties);

    }

  }

  return all_succeeded;

}

Status ReadProperties(const Slice& handle_value, RandomAccessFileReader* file,

                      const Footer& footer, Env* env, Logger* logger,

                      TableProperties** table_properties) {

  assert(table_properties);

  Slice v = handle_value;

  BlockHandle handle;

  if (!handle.DecodeFrom(&v).ok()) {

    return STATUS(InvalidArgument, "Failed to decode properties block handle");

  }

  BlockContents block_contents;

  ReadOptions read_options = CreateMetaBlockReadOptions(file);

  Status s = ReadBlockContents(file, footer, read_options, handle, &block_contents,

                               env, nullptr /* mem_tracker */, false);

  if (!s.ok()) {

    return s;

  }

  Block properties_block(std::move(block_contents));

  std::unique_ptr<InternalIterator> iter(properties_block.NewIterator(

      BytewiseComparator(), kPropertyBlockKeyValueEncodingFormat));

  auto new_table_properties = new TableProperties();

  // All pre-defined properties of type uint64_t

  std::unordered_map<std::string, uint64_t*> predefined_uint64_properties = {

      {TablePropertiesNames::kDataSize, &new_table_properties->data_size},

      {TablePropertiesNames::kDataIndexSize, &new_table_properties->data_index_size},

      {TablePropertiesNames::kFilterSize, &new_table_properties->filter_size},

      {TablePropertiesNames::kFilterIndexSize, &new_table_properties->filter_index_size},

      {TablePropertiesNames::kRawKeySize, &new_table_properties->raw_key_size},

      {TablePropertiesNames::kRawValueSize, &new_table_properties->raw_value_size},

      {TablePropertiesNames::kNumDataBlocks, &new_table_properties->num_data_blocks},

      {TablePropertiesNames::kNumEntries, &new_table_properties->num_entries},

      {TablePropertiesNames::kNumFilterBlocks, &new_table_properties->num_filter_blocks},

      {TablePropertiesNames::kNumDataIndexBlocks, &new_table_properties->num_data_index_blocks},

      {TablePropertiesNames::kFormatVersion, &new_table_properties->format_version},

      {TablePropertiesNames::kFixedKeyLen, &new_table_properties->fixed_key_len}, };

  std::string last_key;

  for (iter->SeekToFirst(); iter->Valid(); iter->Next()) {

    s = iter->status();

    if (!s.ok()) {

      break;

    }

    auto key = iter->key().ToString();

    // properties block is strictly sorted with no duplicate key.

    assert(last_key.empty() ||

           BytewiseComparator()->Compare(key, last_key) > 0);

    last_key = key;

    auto raw_val = iter->value();

    auto pos = predefined_uint64_properties.find(key);

    if (pos != predefined_uint64_properties.end()) {

      // handle predefined rocksdb properties

      uint64_t val;

      if (!GetVarint64(&raw_val, &val)) {

        // skip malformed value

        auto error_msg =

          "Detect malformed value in properties meta-block:"

          "\tkey: " + key + "\tval: " + raw_val.ToString();

        RLOG(InfoLogLevel::ERROR_LEVEL, logger, "%s", error_msg.c_str());

        continue;

      }

      *(pos->second) = val;

    } else if (key == TablePropertiesNames::kFilterPolicy) {

      new_table_properties->filter_policy_name = raw_val.ToString();

    } else {

      // handle user-collected properties

      new_table_properties->user_collected_properties.insert(

          {key, raw_val.ToString()});

    }

  }

  if (s.ok()) {

    *table_properties = new_table_properties;

  } else {

    delete new_table_properties;

  }

  return s;

}

Status ReadTableProperties(RandomAccessFileReader* file, uint64_t file_size,

                           uint64_t table_magic_number, Env* env,

                           Logger* info_log, TableProperties** properties) {

  // -- Read metaindex block

  Footer footer;

  auto s = ReadFooterFromFile(file, file_size, &footer, table_magic_number);

  if (!s.ok()) {

    return s;

  }

  auto metaindex_handle = footer.metaindex_handle();

  BlockContents metaindex_contents;

  ReadOptions read_options = CreateMetaBlockReadOptions(file);

  s = ReadBlockContents(file, footer, read_options, metaindex_handle,

                        &metaindex_contents, env, nullptr /* mem_tracker */, false);

  if (!s.ok()) {

    return s;

  }

  Block metaindex_block(std::move(metaindex_contents));

  std::unique_ptr<InternalIterator> meta_iter(metaindex_block.NewIterator(

      BytewiseComparator(), kMetaIndexBlockKeyValueEncodingFormat));

  // -- Read property block

  bool found_properties_block = true;

  s = SeekToPropertiesBlock(meta_iter.get(), &found_properties_block);

  if (!s.ok()) {

    return s;

  }

  TableProperties table_properties;

  if (found_properties_block == true) {

    s = ReadProperties(meta_iter->value(), file, footer, env, info_log,

                       properties);

  } else {

    s = STATUS(NotFound, "");

  }

  return s;

}

Status FindMetaBlock(InternalIterator* meta_index_iter,

                     const std::string& meta_block_name,

                     BlockHandle* block_handle) {

  meta_index_iter->Seek(meta_block_name);

  if (meta_index_iter->status().ok() && meta_index_iter->Valid() &&

      meta_index_iter->key() == meta_block_name) {

    Slice v = meta_index_iter->value();

    return block_handle->DecodeFrom(&v);

  } else {

    return STATUS(Corruption, "Cannot find the meta block", meta_block_name);

  }

}

Status FindMetaBlock(RandomAccessFileReader* file, uint64_t file_size,

                     uint64_t table_magic_number, Env* env,

                     const std::string& meta_block_name,

                     const std::shared_ptr<yb::MemTracker>& mem_tracker,

                     BlockHandle* block_handle) {

  Footer footer;

  auto s = ReadFooterFromFile(file, file_size, &footer, table_magic_number);

  if (!s.ok()) {

    return s;

  }

  auto metaindex_handle = footer.metaindex_handle();

  BlockContents metaindex_contents;

  ReadOptions read_options = CreateMetaBlockReadOptions(file);

  s = ReadBlockContents(file, footer, read_options, metaindex_handle,

                        &metaindex_contents, env, mem_tracker, false);

  if (!s.ok()) {

    return s;

  }

  Block metaindex_block(std::move(metaindex_contents));

  std::unique_ptr<InternalIterator> meta_iter;

  meta_iter.reset(

      metaindex_block.NewIterator(BytewiseComparator(), kMetaIndexBlockKeyValueEncodingFormat));

  return FindMetaBlock(meta_iter.get(), meta_block_name, block_handle);

}

Status ReadMetaBlock(RandomAccessFileReader* file, uint64_t file_size,

                     uint64_t table_magic_number, Env* env,

                     const std::string& meta_block_name,

                     const std::shared_ptr<yb::MemTracker>& mem_tracker,

                     BlockContents* contents) {

  Status status;

  Footer footer;

  status = ReadFooterFromFile(file, file_size, &footer, table_magic_number);

  if (!status.ok()) {

    return status;

  }

  // Reading metaindex block

  auto metaindex_handle = footer.metaindex_handle();

  BlockContents metaindex_contents;

  ReadOptions read_options = CreateMetaBlockReadOptions(file);

  status = ReadBlockContents(file, footer, read_options, metaindex_handle,

                             &metaindex_contents, env, mem_tracker, false);

  if (!status.ok()) {

    return status;

  }

  // Finding metablock

  Block metaindex_block(std::move(metaindex_contents));

  std::unique_ptr<InternalIterator> meta_iter;

  meta_iter.reset(

      metaindex_block.NewIterator(BytewiseComparator(), kMetaIndexBlockKeyValueEncodingFormat));

  BlockHandle block_handle;

  status = FindMetaBlock(meta_iter.get(), meta_block_name, &block_handle);

  if (!status.ok()) {

    return status;

  }

  // Reading metablock

  return ReadBlockContents(

      file, footer, read_options, block_handle, contents, env, mem_tracker, false);

}

}  // namespace rocksdb