mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
86a0133d05
Summary: This is a temp solution to expose index sizes to users from PlainTableReader before we persistent them to files. In this patch, the memory consumption of indexes used by PlainTableReader will be reported as two user defined properties, so that users can monitor them. Test Plan: Add a unit test. make all check` Reviewers: haobo, ljin Reviewed By: haobo CC: nkg-, yhchiang, igor, ljin, dhruba, leveldb Differential Revision: https://reviews.facebook.net/D18195
113 lines
4.1 KiB
C++
113 lines
4.1 KiB
C++
// Copyright (c) 2011 The LevelDB Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style license that can be
|
|
// found in the LICENSE file. See the AUTHORS file for names of contributors.
|
|
#pragma once
|
|
|
|
#include <string>
|
|
#include <map>
|
|
#include "rocksdb/status.h"
|
|
|
|
namespace rocksdb {
|
|
|
|
// -- Table Properties
|
|
// Other than basic table properties, each table may also have the user
|
|
// collected properties.
|
|
// The value of the user-collected properties are encoded as raw bytes --
|
|
// users have to interprete these values by themselves.
|
|
// Note: To do prefix seek/scan in `UserCollectedProperties`, you can do
|
|
// something similar to:
|
|
//
|
|
// UserCollectedProperties props = ...;
|
|
// for (auto pos = props.lower_bound(prefix);
|
|
// pos != props.end() && pos->first.compare(0, prefix.size(), prefix) == 0;
|
|
// ++pos) {
|
|
// ...
|
|
// }
|
|
typedef std::map<const std::string, std::string> UserCollectedProperties;
|
|
|
|
// TableProperties contains a bunch of read-only properties of its associated
|
|
// table.
|
|
struct TableProperties {
|
|
public:
|
|
// the total size of all data blocks.
|
|
uint64_t data_size = 0;
|
|
// the size of index block.
|
|
uint64_t index_size = 0;
|
|
// the size of filter block.
|
|
uint64_t filter_size = 0;
|
|
// total raw key size
|
|
uint64_t raw_key_size = 0;
|
|
// total raw value size
|
|
uint64_t raw_value_size = 0;
|
|
// the number of blocks in this table
|
|
uint64_t num_data_blocks = 0;
|
|
// the number of entries in this table
|
|
uint64_t num_entries = 0;
|
|
// format version, reserved for backward compatibility
|
|
uint64_t format_version = 0;
|
|
// If 0, key is variable length. Otherwise number of bytes for each key.
|
|
uint64_t fixed_key_len = 0;
|
|
|
|
// The name of the filter policy used in this table.
|
|
// If no filter policy is used, `filter_policy_name` will be an empty string.
|
|
std::string filter_policy_name;
|
|
|
|
// user collected properties
|
|
UserCollectedProperties user_collected_properties;
|
|
|
|
// convert this object to a human readable form
|
|
// @prop_delim: delimiter for each property.
|
|
std::string ToString(const std::string& prop_delim = "; ",
|
|
const std::string& kv_delim = "=") const;
|
|
};
|
|
|
|
// table properties' human-readable names in the property block.
|
|
struct TablePropertiesNames {
|
|
static const std::string kDataSize;
|
|
static const std::string kIndexSize;
|
|
static const std::string kFilterSize;
|
|
static const std::string kRawKeySize;
|
|
static const std::string kRawValueSize;
|
|
static const std::string kNumDataBlocks;
|
|
static const std::string kNumEntries;
|
|
static const std::string kFormatVersion;
|
|
static const std::string kFixedKeyLen;
|
|
static const std::string kFilterPolicy;
|
|
};
|
|
|
|
extern const std::string kPropertiesBlock;
|
|
|
|
// `TablePropertiesCollector` provides the mechanism for users to collect
|
|
// their own interested properties. This class is essentially a collection
|
|
// of callback functions that will be invoked during table building.
|
|
class TablePropertiesCollector {
|
|
public:
|
|
virtual ~TablePropertiesCollector() {}
|
|
|
|
// Add() will be called when a new key/value pair is inserted into the table.
|
|
// @params key the original key that is inserted into the table.
|
|
// @params value the original value that is inserted into the table.
|
|
virtual Status Add(const Slice& key, const Slice& value) = 0;
|
|
|
|
// Finish() will be called when a table has already been built and is ready
|
|
// for writing the properties block.
|
|
// @params properties User will add their collected statistics to
|
|
// `properties`.
|
|
virtual Status Finish(UserCollectedProperties* properties) = 0;
|
|
|
|
// The name of the properties collector can be used for debugging purpose.
|
|
virtual const char* Name() const = 0;
|
|
|
|
// Return the human-readable properties, where the key is property name and
|
|
// the value is the human-readable form of value.
|
|
virtual UserCollectedProperties GetReadableProperties() const = 0;
|
|
};
|
|
|
|
// Extra properties
|
|
// Below is a list of non-basic properties that are collected by database
|
|
// itself. Especially some properties regarding to the internal keys (which
|
|
// is unknown to `table`).
|
|
extern uint64_t GetDeletedKeys(const UserCollectedProperties& props);
|
|
|
|
} // namespace rocksdb
|