Skip to content

Attempt to disable NvmCacheState when NVM cache is not enabled. #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 29, 2021
Merged

Attempt to disable NvmCacheState when NVM cache is not enabled. #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7ef7b14
Disabled NvmCacheState when NVM cache is not enabled.
victoria-mcgrath Nov 23, 2021
36fef0e
Changed NvmCacheStas_ to std::optional
victoria-mcgrath Nov 24, 2021
3d70a3e
Changed getNVMCacheCreationTime() to return cacheCreationTime if NVM …
victoria-mcgrath Nov 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 13 additions & 16 deletions cachelib/allocator/CacheAllocator-inl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,7 @@ CacheAllocator<CacheTrait>::CacheAllocator(Config config)
[this](Item* it) -> ItemHandle { return acquire(it); })),
chainedItemLocks_(config_.chainedItemsLockPower,
std::make_shared<MurmurHash2>()),
cacheCreationTime_{util::getCurrentTimeSec()},
nvmCacheState_{config_.cacheDir, config_.isNvmCacheEncryptionEnabled(),
config_.isNvmCacheTruncateAllocSizeEnabled()} {
cacheCreationTime_{util::getCurrentTimeSec()} {
// TODO(MEMORY_TIER)
if (std::holds_alternative<FileShmSegmentOpts>(
memoryTierConfigs[0].getShmTypeOpts())) {
Expand Down Expand Up @@ -97,9 +95,7 @@ CacheAllocator<CacheTrait>::CacheAllocator(SharedMemNewT, Config config)
[this](Item* it) -> ItemHandle { return acquire(it); })),
chainedItemLocks_(config_.chainedItemsLockPower,
std::make_shared<MurmurHash2>()),
cacheCreationTime_{util::getCurrentTimeSec()},
nvmCacheState_{config_.cacheDir, config_.isNvmCacheEncryptionEnabled(),
config_.isNvmCacheTruncateAllocSizeEnabled()} {
cacheCreationTime_{util::getCurrentTimeSec()} {
initCommon(false);
shmManager_->removeShm(detail::kShmInfoName,
PosixSysVSegmentOpts(config_.isUsingPosixShm()));
Expand Down Expand Up @@ -134,9 +130,7 @@ CacheAllocator<CacheTrait>::CacheAllocator(SharedMemAttachT, Config config)
[this](Item* it) -> ItemHandle { return acquire(it); })),
chainedItemLocks_(config_.chainedItemsLockPower,
std::make_shared<MurmurHash2>()),
cacheCreationTime_{*metadata_.cacheCreationTime_ref()},
nvmCacheState_{config_.cacheDir, config_.isNvmCacheEncryptionEnabled(),
config_.isNvmCacheTruncateAllocSizeEnabled()} {
cacheCreationTime_{*metadata_.cacheCreationTime_ref()} {
for (auto pid : *metadata_.compactCachePools_ref()) {
isCompactCachePool_[pid] = true;
}
Expand Down Expand Up @@ -207,7 +201,7 @@ CacheAllocator<CacheTrait>::restoreCCacheManager() {

template <typename CacheTrait>
void CacheAllocator<CacheTrait>::initCommon(bool dramCacheAttached) {
if (config_.nvmConfig.has_value()) {
if (config_.isNvmCacheEnabled()) {
if (config_.nvmCacheAP) {
nvmAdmissionPolicy_ = config_.nvmCacheAP;
} else if (config_.rejectFirstAPNumEntries) {
Expand All @@ -230,24 +224,27 @@ void CacheAllocator<CacheTrait>::initCommon(bool dramCacheAttached) {

template <typename CacheTrait>
void CacheAllocator<CacheTrait>::initNvmCache(bool dramCacheAttached) {
if (!config_.nvmConfig.has_value()) {
if (!config_.isNvmCacheEnabled()) {
return;
}

nvmCacheState_.emplace(NvmCacheState(config_.cacheDir, config_.isNvmCacheEncryptionEnabled(),
config_.isNvmCacheTruncateAllocSizeEnabled()));

// for some usecases that create pools, restoring nvmcache when dram cache
// is not persisted is not supported.
const bool shouldDrop = config_.dropNvmCacheOnShmNew && !dramCacheAttached;

// if we are dealing with persistency, cache directory should be enabled
const bool truncate = config_.cacheDir.empty() ||
nvmCacheState_.shouldStartFresh() || shouldDrop;
nvmCacheState_.value().shouldStartFresh() || shouldDrop;
if (truncate) {
nvmCacheState_.markTruncated();
nvmCacheState_.value().markTruncated();
}

nvmCache_ = std::make_unique<NvmCacheT>(*this, *config_.nvmConfig, truncate);
if (!config_.cacheDir.empty()) {
nvmCacheState_.clearPrevState();
nvmCacheState_.value().clearPrevState();
}
}

Expand Down Expand Up @@ -3057,7 +3054,7 @@ std::optional<bool> CacheAllocator<CacheTrait>::saveNvmCache() {
return false;
}

nvmCacheState_.markSafeShutDown();
nvmCacheState_.value().markSafeShutDown();
return true;
}

Expand Down Expand Up @@ -3252,8 +3249,8 @@ GlobalCacheStats CacheAllocator<CacheTrait>::getGlobalCacheStats() const {

const uint64_t currTime = util::getCurrentTimeSec();
ret.ramUpTime = currTime - cacheCreationTime_;
ret.nvmUpTime = currTime - nvmCacheState_.getCreationTime();
ret.nvmCacheEnabled = nvmCache_ ? nvmCache_->isEnabled() : false;
ret.nvmUpTime = currTime - getNVMCacheCreationTime();
ret.reaperStats = getReaperStats();
ret.numActiveHandles = getNumActiveHandles();

Expand Down
13 changes: 11 additions & 2 deletions cachelib/allocator/CacheAllocator.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -968,8 +968,17 @@ class CacheAllocator : public CacheBase {
//
// @return time when the cache was created.
time_t getCacheCreationTime() const noexcept { return cacheCreationTime_; }

// unix timestamp when the NVM cache was created. If NVM cahce isn't enaled,
// the cache creation time is returned instead.
//
// @return time when the NVM cache was created.
time_t getNVMCacheCreationTime() const {
return nvmCacheState_.getCreationTime();
auto result = getCacheCreationTime();
if (nvmCacheState_.has_value()) {
result = nvmCacheState_.value().getCreationTime();
}
return result;
}

// Inspects the cache without changing its state.
Expand Down Expand Up @@ -1812,7 +1821,7 @@ class CacheAllocator : public CacheBase {
folly::ThreadLocal<TlsActiveItemRing, DummyTlsActiveItemRingTag> ring_;

// state for the nvmcache
NvmCacheState nvmCacheState_;
std::optional<NvmCacheState> nvmCacheState_{};

// admission policy for nvmcache
std::shared_ptr<NvmAdmissionPolicy<CacheT>> nvmAdmissionPolicy_;
Expand Down
7 changes: 7 additions & 0 deletions cachelib/allocator/CacheAllocatorConfig.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ class CacheAllocatorConfig {
// Config for NvmCache. If enabled, cachelib will also make use of flash.
CacheAllocatorConfig& enableNvmCache(NvmCacheConfig config);

bool isNvmCacheEnabled() const;

// enable the reject first admission policy through its parameters
// @param numEntries the number of entries to track across all splits
// @param numSplits the number of splits. we drop a whole split by
Expand Down Expand Up @@ -660,6 +662,11 @@ CacheAllocatorConfig<T>& CacheAllocatorConfig<T>::enableNvmCache(
return *this;
}

template <typename T>
bool CacheAllocatorConfig<T>::isNvmCacheEnabled() const {
return nvmConfig.has_value();
}

template <typename T>
CacheAllocatorConfig<T>& CacheAllocatorConfig<T>::setNvmCacheAdmissionPolicy(
std::shared_ptr<NvmAdmissionPolicy<T>> policy) {
Expand Down