13232e11d4
Summary: This PR adds a ```-secondary_cache_uri``` option to the cache_bench and db_bench tools to allow the user to specify a custom secondary cache URI. The object registry is used to create an instance of the ```SecondaryCache``` object of the type specified in the URI. The main cache_bench code is packaged into a separate library, similar to db_bench. An example invocation of db_bench with a secondary cache URI - ```db_bench --env_uri=ws://ws.flash_sandbox.vll1_2/ -db=anand/nvm_cache_2 -use_existing_db=true -benchmarks=readrandom -num=30000000 -key_size=32 -value_size=256 -use_direct_reads=true -cache_size=67108864 -cache_index_and_filter_blocks=true -secondary_cache_uri='cachelibwrapper://filename=/home/anand76/nvm_cache/cache_file;size=2147483648;regionSize=16777216;admPolicy=random;admProbability=1.0;volatileSize=8388608;bktPower=20;lockPower=12' -partition_index_and_filters=true -duration=1800``` Pull Request resolved: https://github.com/facebook/rocksdb/pull/8312 Reviewed By: zhichao-cao Differential Revision: D28544325 Pulled By: anand1976 fbshipit-source-id: 8f209b9af900c459dc42daa7a610d5f00176eeed
80 lines
2.7 KiB
C++
80 lines
2.7 KiB
C++
// Copyright (c) 2021, 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).
|
|
#pragma once
|
|
|
|
#include <stdint.h>
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
#include "rocksdb/cache.h"
|
|
#include "rocksdb/slice.h"
|
|
#include "rocksdb/statistics.h"
|
|
#include "rocksdb/status.h"
|
|
|
|
namespace ROCKSDB_NAMESPACE {
|
|
|
|
// A handle for lookup result. The handle may not be immediately ready or
|
|
// have a valid value. The caller must call isReady() to determine if its
|
|
// ready, and call Wait() in order to block until it becomes ready.
|
|
// The caller must call value() after it becomes ready to determine if the
|
|
// handle successfullly read the item.
|
|
class SecondaryCacheHandle {
|
|
public:
|
|
virtual ~SecondaryCacheHandle() {}
|
|
|
|
// Returns whether the handle is ready or not
|
|
virtual bool IsReady() = 0;
|
|
|
|
// Block until handle becomes ready
|
|
virtual void Wait() = 0;
|
|
|
|
// Return the value. If nullptr, it means the lookup was unsuccessful
|
|
virtual void* Value() = 0;
|
|
|
|
// Return the size of value
|
|
virtual size_t Size() = 0;
|
|
};
|
|
|
|
// SecondaryCache
|
|
//
|
|
// Cache interface for caching blocks on a secondary tier (which can include
|
|
// non-volatile media, or alternate forms of caching such as compressed data)
|
|
class SecondaryCache {
|
|
public:
|
|
virtual ~SecondaryCache() {}
|
|
|
|
virtual std::string Name() = 0;
|
|
|
|
static const std::string Type() { return "SecondaryCache"; }
|
|
|
|
// Insert the given value into this cache. The value is not written
|
|
// directly. Rather, the SaveToCallback provided by helper_cb will be
|
|
// used to extract the persistable data in value, which will be written
|
|
// to this tier. The implementation may or may not write it to cache
|
|
// depending on the admission control policy, even if the return status is
|
|
// success.
|
|
virtual Status Insert(const Slice& key, void* value,
|
|
const Cache::CacheItemHelper* helper) = 0;
|
|
|
|
// Lookup the data for the given key in this cache. The create_cb
|
|
// will be used to create the object. The handle returned may not be
|
|
// ready yet, unless wait=true, in which case Lookup() will block until
|
|
// the handle is ready
|
|
virtual std::unique_ptr<SecondaryCacheHandle> Lookup(
|
|
const Slice& key, const Cache::CreateCallback& create_cb, bool wait) = 0;
|
|
|
|
// At the discretion of the implementation, erase the data associated
|
|
// with key
|
|
virtual void Erase(const Slice& key) = 0;
|
|
|
|
// Wait for a collection of handles to become ready
|
|
virtual void WaitAll(std::vector<SecondaryCacheHandle*> handles) = 0;
|
|
|
|
virtual std::string GetPrintableOptions() const = 0;
|
|
};
|
|
|
|
} // namespace ROCKSDB_NAMESPACE
|