mirror of
https://github.com/facebook/rocksdb.git
synced 2024-12-04 11:03:22 +00:00
a28cc4a38c
Summary:
An earlier change (b34cef57b7) removed apparently unused functionality where an obsolete blob file number is passed for removal from TableCache, which manages SST files. This was actually relying on broken/fragile abstractions wherein TableCache and BlobFileCache share the same Cache and using the TableCache interface to manipulate blob file caching. No unit test was actually checking for removal of obsolete blob files from the cache (which is somewhat tricky to check and a second order correctness requirement).
Here we fix the leak and add a DEBUG+ASAN-only check in DB::Close() that no obsolete files are lingering in the table/blob file cache.
Fixes https://github.com/facebook/rocksdb/issues/13066
Important follow-up (FIXME): The added check discovered some apparent cases of leaked (into table_cache) SST file readers that would stick around until DB::Close(). Need to enable that check, diagnose, and fix.
Pull Request resolved: https://github.com/facebook/rocksdb/pull/13106
Test Plan:
added a check that is called during DB::Close in ASAN builds (to minimize paying the cost in all unit tests). Without the fix, the check failed in at least these tests:
```
db_blob_basic_test DBBlobBasicTest.DynamicallyWarmCacheDuringFlush
db_blob_compaction_test DBBlobCompactionTest.CompactionReadaheadMerge
db_blob_compaction_test DBBlobCompactionTest.MergeBlobWithBase
db_blob_compaction_test DBBlobCompactionTest.CompactionDoNotFillCache
db_blob_compaction_test DBBlobCompactionTest.SkipUntilFilter
db_blob_compaction_test DBBlobCompactionTest.CompactionFilter
db_blob_compaction_test DBBlobCompactionTest.CompactionReadaheadFilter
db_blob_compaction_test DBBlobCompactionTest.CompactionReadaheadGarbageCollection
```
Reviewed By: ltamasi
Differential Revision: D65296123
Pulled By: pdillinger
fbshipit-source-id: 2276d76482beb2c75c9010bc1bec070bb23a24c0
112 lines
3 KiB
C++
112 lines
3 KiB
C++
// 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_cache.h"
|
|
|
|
#include <cassert>
|
|
#include <memory>
|
|
|
|
#include "db/blob/blob_file_reader.h"
|
|
#include "options/cf_options.h"
|
|
#include "rocksdb/cache.h"
|
|
#include "rocksdb/slice.h"
|
|
#include "test_util/sync_point.h"
|
|
#include "trace_replay/io_tracer.h"
|
|
#include "util/hash.h"
|
|
|
|
namespace ROCKSDB_NAMESPACE {
|
|
|
|
BlobFileCache::BlobFileCache(Cache* cache,
|
|
const ImmutableOptions* immutable_options,
|
|
const FileOptions* file_options,
|
|
uint32_t column_family_id,
|
|
HistogramImpl* blob_file_read_hist,
|
|
const std::shared_ptr<IOTracer>& io_tracer)
|
|
: cache_(cache),
|
|
mutex_(kNumberOfMutexStripes),
|
|
immutable_options_(immutable_options),
|
|
file_options_(file_options),
|
|
column_family_id_(column_family_id),
|
|
blob_file_read_hist_(blob_file_read_hist),
|
|
io_tracer_(io_tracer) {
|
|
assert(cache_);
|
|
assert(immutable_options_);
|
|
assert(file_options_);
|
|
}
|
|
|
|
Status BlobFileCache::GetBlobFileReader(
|
|
const ReadOptions& read_options, uint64_t blob_file_number,
|
|
CacheHandleGuard<BlobFileReader>* blob_file_reader) {
|
|
assert(blob_file_reader);
|
|
assert(blob_file_reader->IsEmpty());
|
|
|
|
// NOTE: sharing same Cache with table_cache
|
|
const Slice key = GetSliceForKey(&blob_file_number);
|
|
|
|
assert(cache_);
|
|
|
|
TypedHandle* handle = cache_.Lookup(key);
|
|
if (handle) {
|
|
*blob_file_reader = cache_.Guard(handle);
|
|
return Status::OK();
|
|
}
|
|
|
|
TEST_SYNC_POINT("BlobFileCache::GetBlobFileReader:DoubleCheck");
|
|
|
|
// Check again while holding mutex
|
|
MutexLock lock(&mutex_.Get(key));
|
|
|
|
handle = cache_.Lookup(key);
|
|
if (handle) {
|
|
*blob_file_reader = cache_.Guard(handle);
|
|
return Status::OK();
|
|
}
|
|
|
|
assert(immutable_options_);
|
|
Statistics* const statistics = immutable_options_->stats;
|
|
|
|
RecordTick(statistics, NO_FILE_OPENS);
|
|
|
|
std::unique_ptr<BlobFileReader> reader;
|
|
|
|
{
|
|
assert(file_options_);
|
|
const Status s = BlobFileReader::Create(
|
|
*immutable_options_, read_options, *file_options_, column_family_id_,
|
|
blob_file_read_hist_, blob_file_number, io_tracer_, &reader);
|
|
if (!s.ok()) {
|
|
RecordTick(statistics, NO_FILE_ERRORS);
|
|
return s;
|
|
}
|
|
}
|
|
|
|
{
|
|
constexpr size_t charge = 1;
|
|
|
|
const Status s = cache_.Insert(key, reader.get(), charge, &handle);
|
|
if (!s.ok()) {
|
|
RecordTick(statistics, NO_FILE_ERRORS);
|
|
return s;
|
|
}
|
|
}
|
|
|
|
reader.release();
|
|
|
|
*blob_file_reader = cache_.Guard(handle);
|
|
|
|
return Status::OK();
|
|
}
|
|
|
|
void BlobFileCache::Evict(uint64_t blob_file_number) {
|
|
// NOTE: sharing same Cache with table_cache
|
|
const Slice key = GetSliceForKey(&blob_file_number);
|
|
|
|
assert(cache_);
|
|
|
|
cache_.get()->Erase(key);
|
|
}
|
|
|
|
} // namespace ROCKSDB_NAMESPACE
|