From 4c05d1041461b630cd5770dae5e8d03147d5674b Mon Sep 17 00:00:00 2001
From: Dan Engelbrecht <dan.engelbrecht@epicgames.com>
Date: Wed, 20 Aug 2025 12:33:03 +0200
Subject: per namespace/project cas prep refactor (#470)

- Refactor so we can have more than one cas store for project store and cache.
- Refactor `UpstreamCacheClient` so it is not tied to a specific CidStore
- Refactor scrub to keep the GC interface ScrubStorage function separate from scrub accessor functions (renamed to Scrub).
- Refactor storage size to keep GC interface StorageSize function separate from size accessor functions (renamed to TotalSize)
- Refactor cache storage so  `ZenCacheDiskLayer::CacheBucket` implements GcStorage interface rather than `ZenCacheNamespace`
---
 src/zenstore/cache/structuredcachestore.cpp | 68 ++++++++++++-----------------
 1 file changed, 29 insertions(+), 39 deletions(-)

(limited to 'src/zenstore/cache/structuredcachestore.cpp')

diff --git a/src/zenstore/cache/structuredcachestore.cpp b/src/zenstore/cache/structuredcachestore.cpp
index 973af52b2..1f2d6c37f 100644
--- a/src/zenstore/cache/structuredcachestore.cpp
+++ b/src/zenstore/cache/structuredcachestore.cpp
@@ -139,13 +139,10 @@ ZenCacheNamespace::ZenCacheNamespace(GcManager& Gc, JobQueue& JobQueue, const st
 	CreateDirectories(m_RootDir);
 
 	m_DiskLayer.DiscoverBuckets();
-
-	m_Gc.AddGcStorage(this);
 }
 
 ZenCacheNamespace::~ZenCacheNamespace()
 {
-	m_Gc.RemoveGcStorage(this);
 }
 
 struct ZenCacheNamespace::PutBatchHandle
@@ -302,7 +299,6 @@ ZenCacheNamespace::EnumerateBucketContents(std::string_view
 std::function<void()>
 ZenCacheNamespace::Drop()
 {
-	m_Gc.RemoveGcStorage(this);
 	return m_DiskLayer.Drop();
 }
 
@@ -312,25 +308,19 @@ ZenCacheNamespace::Flush()
 	m_DiskLayer.Flush();
 }
 
+#if ZEN_WITH_TESTS
 void
-ZenCacheNamespace::ScrubStorage(ScrubContext& Ctx)
+ZenCacheNamespace::Scrub(ScrubContext& Ctx)
 {
-	if (m_LastScrubTime == Ctx.ScrubTimestamp())
-	{
-		return;
-	}
-
 	ZEN_INFO("scrubbing '{}'", m_RootDir);
-
-	m_LastScrubTime = Ctx.ScrubTimestamp();
-
-	m_DiskLayer.ScrubStorage(Ctx);
+	m_DiskLayer.Scrub(Ctx);
 }
+#endif	// ZEN_WITH_TESTS
 
-GcStorageSize
-ZenCacheNamespace::StorageSize() const
+CacheStoreSize
+ZenCacheNamespace::TotalSize() const
 {
-	return m_DiskLayer.StorageSize();
+	return m_DiskLayer.TotalSize();
 }
 
 ZenCacheNamespace::Info
@@ -836,11 +826,13 @@ ZenCacheStore::Flush()
 	IterateNamespaces([&](std::string_view, ZenCacheNamespace& Store) { Store.Flush(); });
 }
 
+#if ZEN_WITH_TESTS
 void
-ZenCacheStore::ScrubStorage(ScrubContext& Ctx)
+ZenCacheStore::Scrub(ScrubContext& Ctx)
 {
-	IterateNamespaces([&](std::string_view, ZenCacheNamespace& Store) { Store.ScrubStorage(Ctx); });
+	IterateNamespaces([&](std::string_view, ZenCacheNamespace& Store) { Store.Scrub(Ctx); });
 }
+#endif	// ZEN_WITH_TESTS
 
 CacheValueDetails
 ZenCacheStore::GetValueDetails(const std::string_view NamespaceFilter,
@@ -965,12 +957,12 @@ ZenCacheStore::IterateNamespaces(const std::function<void(std::string_view Names
 	}
 }
 
-GcStorageSize
-ZenCacheStore::StorageSize() const
+CacheStoreSize
+ZenCacheStore::TotalSize() const
 {
-	GcStorageSize Size;
+	CacheStoreSize Size;
 	IterateNamespaces([&](std::string_view, ZenCacheNamespace& Store) {
-		GcStorageSize StoreSize = Store.StorageSize();
+		CacheStoreSize StoreSize = Store.TotalSize();
 		Size.MemorySize += StoreSize.MemorySize;
 		Size.DiskSize += StoreSize.DiskSize;
 	});
@@ -1040,7 +1032,7 @@ ZenCacheStore::SetLoggingConfig(const Configuration::LogConfig& Loggingconfig)
 ZenCacheStore::Info
 ZenCacheStore::GetInfo() const
 {
-	ZenCacheStore::Info Info = {.Config = m_Configuration, .StorageSize = StorageSize()};
+	ZenCacheStore::Info Info = {.Config = m_Configuration, .StorageSize = TotalSize()};
 
 	IterateNamespaces([&Info](std::string_view NamespaceName, ZenCacheNamespace& Namespace) {
 		Info.NamespaceNames.push_back(std::string(NamespaceName));
@@ -1428,7 +1420,7 @@ TEST_CASE("cachestore.size")
 		const size_t			 Count = 16;
 		ScopedTemporaryDirectory TempDir;
 
-		GcStorageSize CacheSize;
+		CacheStoreSize CacheSize;
 
 		{
 			GcManager		  Gc;
@@ -1449,7 +1441,7 @@ TEST_CASE("cachestore.size")
 				Zcs.Put(BucketName, Hash, ZenCacheValue{.Value = Buffer}, {}, false);
 				Keys.push_back({BucketName, Hash});
 			}
-			CacheSize = Zcs.StorageSize();
+			CacheSize = Zcs.TotalSize();
 			CHECK_LE(CacheValue.GetSize() * Count, CacheSize.DiskSize);
 			CHECK_EQ(0, CacheSize.MemorySize);
 
@@ -1459,7 +1451,7 @@ TEST_CASE("cachestore.size")
 				Zcs.Get(Key.first, Key.second, _);
 			}
 
-			CacheSize = Zcs.StorageSize();
+			CacheSize = Zcs.TotalSize();
 			CHECK_LE(CacheValue.GetSize() * Count, CacheSize.DiskSize);
 			CHECK_LE(CacheValue.GetSize() * Count, CacheSize.MemorySize);
 		}
@@ -1468,7 +1460,7 @@ TEST_CASE("cachestore.size")
 			GcManager		  Gc;
 			ZenCacheNamespace Zcs(Gc, *JobQueue, TempDir.Path() / "cache", {});
 
-			const GcStorageSize SerializedSize = Zcs.StorageSize();
+			const CacheStoreSize SerializedSize = Zcs.TotalSize();
 			CHECK_EQ(SerializedSize.MemorySize, 0);
 			CHECK_LE(SerializedSize.DiskSize, CacheSize.DiskSize);
 
@@ -1476,8 +1468,8 @@ TEST_CASE("cachestore.size")
 			{
 				Zcs.DropBucket(fmt::format("test_bucket-{}", Bucket));
 			}
-			CHECK_EQ(0, Zcs.StorageSize().DiskSize);
-			CHECK_EQ(0, Zcs.StorageSize().MemorySize);
+			CHECK_EQ(0, Zcs.TotalSize().DiskSize);
+			CHECK_EQ(0, Zcs.TotalSize().MemorySize);
 		}
 	}
 
@@ -1486,7 +1478,7 @@ TEST_CASE("cachestore.size")
 		const size_t			 Count = 16;
 		ScopedTemporaryDirectory TempDir;
 
-		GcStorageSize CacheSize;
+		CacheStoreSize CacheSize;
 
 		{
 			GcManager		  Gc;
@@ -1503,7 +1495,7 @@ TEST_CASE("cachestore.size")
 				Zcs.Put(fmt::format("test_bucket-{}", Bucket), IoHash::HashBuffer(&Key, sizeof(uint32_t)), {.Value = Buffer}, {}, false);
 			}
 
-			CacheSize = Zcs.StorageSize();
+			CacheSize = Zcs.TotalSize();
 			CHECK_LE(CacheValue.GetSize() * Count, CacheSize.DiskSize);
 			CHECK_EQ(0, CacheSize.MemorySize);
 		}
@@ -1512,7 +1504,7 @@ TEST_CASE("cachestore.size")
 			GcManager		  Gc;
 			ZenCacheNamespace Zcs(Gc, *JobQueue, TempDir.Path() / "cache", {});
 
-			const GcStorageSize SerializedSize = Zcs.StorageSize();
+			const CacheStoreSize SerializedSize = Zcs.TotalSize();
 			CHECK_EQ(SerializedSize.MemorySize, 0);
 			CHECK_LE(SerializedSize.DiskSize, CacheSize.DiskSize);
 
@@ -1520,7 +1512,7 @@ TEST_CASE("cachestore.size")
 			{
 				Zcs.DropBucket(fmt::format("test_bucket-{}", Bucket));
 			}
-			CHECK_EQ(0, Zcs.StorageSize().DiskSize);
+			CHECK_EQ(0, Zcs.TotalSize().DiskSize);
 		}
 	}
 }
@@ -1613,7 +1605,7 @@ TEST_CASE("cachestore.threadedinsert")	// * doctest::skip(true))
 			GcChunkHashes.swap(RemainingChunkHashes);
 		};
 
-		const uint64_t TotalSize = Zcs.StorageSize().DiskSize;
+		const uint64_t TotalSize = Zcs.TotalSize().DiskSize;
 		CHECK_LE(kChunkSize * Chunks.size(), TotalSize);
 
 		{
@@ -1971,8 +1963,6 @@ TEST_CASE("cachestore.blocked.disklayer.put")
 {
 	ScopedTemporaryDirectory TempDir;
 
-	GcStorageSize CacheSize;
-
 	const auto CreateCacheValue = [](size_t Size) -> CbObject {
 		std::vector<uint8_t> Buf;
 		Buf.resize(Size, Size & 0xff);
@@ -2108,8 +2098,8 @@ TEST_CASE("cachestore.scrub")
 
 	WorkerThreadPool ThreadPool{1};
 	ScrubContext	 ScrubCtx{ThreadPool};
-	Zcs.ScrubStorage(ScrubCtx);
-	CidStore.ScrubStorage(ScrubCtx);
+	Zcs.Scrub(ScrubCtx);
+	CidStore.Scrub(ScrubCtx);
 	CHECK(ScrubCtx.ScrubbedChunks() == (StructuredCids.size() + StructuredCids.size() * AttachmentSizes.size()) + UnstructuredCids.size());
 	CHECK(ScrubCtx.BadCids().GetSize() == 0);
 }
-- 
cgit v1.2.3