aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/zenserver-test/zenserver-test.cpp14
-rw-r--r--src/zenserver/cache/httpstructuredcache.cpp15
-rw-r--r--src/zenstore/cache/cachedisklayer.cpp30
-rw-r--r--src/zenstore/cache/cacherpc.cpp107
-rw-r--r--src/zenstore/cache/structuredcachestore.cpp9
-rw-r--r--src/zenstore/include/zenstore/cache/cachedisklayer.h3
-rw-r--r--src/zenstore/include/zenstore/cache/cacherpc.h4
-rw-r--r--src/zenutil/cache/cacherequests.cpp21
-rw-r--r--src/zenutil/include/zenutil/cache/cacherequests.h3
9 files changed, 157 insertions, 49 deletions
diff --git a/src/zenserver-test/zenserver-test.cpp b/src/zenserver-test/zenserver-test.cpp
index 79e5db554..0ea953937 100644
--- a/src/zenserver-test/zenserver-test.cpp
+++ b/src/zenserver-test/zenserver-test.cpp
@@ -1556,6 +1556,7 @@ TEST_CASE("zcache.rpc")
{
CHECK(ResponseSuccess);
}
+ CHECK(ParsedResult.Details.empty());
}
auto CheckRecordCorrectness = [&](const ZenConfig& Cfg) {
@@ -1619,9 +1620,18 @@ TEST_CASE("zcache.rpc")
CbPackage Response = ParsePackageMessage(zen::IoBuffer(zen::IoBuffer::Wrap, Result.text.data(), Result.text.size()));
CHECK(!Response.IsNull());
CHECK(ParsedResult.Parse(Response));
+ CHECK(Request.Requests.size() == ParsedResult.Success.size());
for (bool ResponseSuccess : ParsedResult.Success)
{
- CHECK(!ResponseSuccess);
+ CHECK(ResponseSuccess);
+ }
+ CHECK(Request.Requests.size() == ParsedResult.Details.size());
+ for (const CbObjectView& Details : ParsedResult.Details)
+ {
+ CHECK(Details);
+ CHECK(Details["RawHash"sv].IsHash());
+ CHECK(Details["RawSize"sv].IsInteger());
+ CHECK(Details["Record"sv].IsObject());
}
}
@@ -1690,6 +1700,7 @@ TEST_CASE("zcache.rpc")
{
CHECK(ResponseSuccess);
}
+ CHECK(ParsedResult.Details.empty());
}
auto CheckRecordCorrectness = [&](const ZenConfig& Cfg) {
@@ -1753,6 +1764,7 @@ TEST_CASE("zcache.rpc")
{
CHECK(ResponseSuccess);
}
+ CHECK(ParsedResult.Details.empty());
}
auto CheckRecordCorrectness = [&](const ZenConfig& Cfg) {
diff --git a/src/zenserver/cache/httpstructuredcache.cpp b/src/zenserver/cache/httpstructuredcache.cpp
index c83065506..bc3f4ee20 100644
--- a/src/zenserver/cache/httpstructuredcache.cpp
+++ b/src/zenserver/cache/httpstructuredcache.cpp
@@ -821,7 +821,8 @@ HttpStructuredCacheService::HandleGetCacheRecord(HttpServerRequest& Request, con
const bool SkipData = EnumHasAllFlags(PolicyFromUrl, CachePolicy::SkipData);
const bool PartialRecord = EnumHasAllFlags(PolicyFromUrl, CachePolicy::PartialRecord);
- bool Success = false;
+ bool Success = false;
+ uint32_t MissingCount = 0;
ZenCacheValue ClientResultValue;
if (!EnumHasAnyFlags(PolicyFromUrl, CachePolicy::Query))
{
@@ -844,7 +845,6 @@ HttpStructuredCacheService::HandleGetCacheRecord(HttpServerRequest& Request, con
if (ContentType == ZenContentType::kCbObject)
{
CbPackage Package;
- uint32_t MissingCount = 0;
CbValidateError ValidateError = CbValidateError::None;
if (CbObject PackageObject = ValidateAndReadCompactBinaryObject(std::move(ClientResultValue.Value), ValidateError);
ValidateError == CbValidateError::None)
@@ -936,7 +936,9 @@ HttpStructuredCacheService::HandleGetCacheRecord(HttpServerRequest& Request, con
else
{
// kCbPackage handled SkipData when constructing the ClientResultValue, kcbObject ignores SkipData
- return Request.WriteResponse(HttpResponseCode::OK, ClientResultValue.Value.GetContentType(), ClientResultValue.Value);
+ return Request.WriteResponse((MissingCount == 0) ? HttpResponseCode::OK : HttpResponseCode::PartialContent,
+ ClientResultValue.Value.GetContentType(),
+ ClientResultValue.Value);
}
}
else if (!HasUpstream || !EnumHasAllFlags(PolicyFromUrl, CachePolicy::QueryRemote))
@@ -1221,8 +1223,11 @@ HttpStructuredCacheService::HandlePutCacheRecord(HttpServerRequest& Request, con
break;
}
- return PutResult.Message.empty() ? Request.WriteResponse(ResponseCode)
- : Request.WriteResponse(ResponseCode, zen::HttpContentType::kText, PutResult.Message);
+ if (PutResult.Details)
+ {
+ Request.WriteResponse(ResponseCode, PutResult.Details);
+ }
+ return Request.WriteResponse(ResponseCode);
};
const HttpContentType ContentType = Request.RequestContentType();
diff --git a/src/zenstore/cache/cachedisklayer.cpp b/src/zenstore/cache/cachedisklayer.cpp
index fd52cdab5..ba82dd942 100644
--- a/src/zenstore/cache/cachedisklayer.cpp
+++ b/src/zenstore/cache/cachedisklayer.cpp
@@ -1968,17 +1968,19 @@ ZenCacheDiskLayer::CacheBucket::ShouldRejectPut(const IoHash& HashKey,
IndexLock.ReleaseNow();
if (!cache::impl::UpdateValueWithRawSizeAndHash(InOutValue))
{
- OutPutResult = PutResult{zen::PutStatus::Fail, "Value provided is of bad format"};
+ CbObjectWriter DetailWriter;
+ DetailWriter.AddString("Message", "Value provided is of bad format");
+ OutPutResult = PutResult{zen::PutStatus::Fail, DetailWriter.Save()};
return true;
}
else if (MetaData.RawSize != InOutValue.RawSize || MetaData.RawHash != InOutValue.RawHash)
{
- OutPutResult = PutResult{
- zen::PutStatus::Conflict,
- fmt::format("Value exists with different size '{}' or hash '{}'", MetaData.RawSize, MetaData.RawHash)};
- return true;
+ // Deliberate fall through without return so that we load the value and include it in the result
+ }
+ else
+ {
+ return false;
}
- return false;
}
}
@@ -2008,16 +2010,22 @@ ZenCacheDiskLayer::CacheBucket::ShouldRejectPut(const IoHash& HashKey,
{
if (!cache::impl::UpdateValueWithRawSizeAndHash(InOutValue))
{
- OutPutResult = PutResult{zen::PutStatus::Fail, "Value provided is of bad format"};
+ CbObjectWriter DetailWriter;
+ DetailWriter.AddString("Message", "Value provided is of bad format");
+ OutPutResult = PutResult{zen::PutStatus::Fail, DetailWriter.Save()};
return true;
}
if (ExistingValue.RawSize != InOutValue.RawSize || ExistingValue.RawHash != InOutValue.RawHash)
{
- OutPutResult = PutResult{zen::PutStatus::Conflict,
- fmt::format("Value exists with different size '{}' or hash '{}'",
- ExistingValue.RawSize,
- ExistingValue.RawHash)};
+ CbObjectWriter DetailWriter;
+ DetailWriter.AddInteger("RawSize", ExistingValue.RawSize);
+ DetailWriter.AddHash("RawHash", ExistingValue.RawHash);
+ if (Location.IsFlagSet(DiskLocation::kStructured))
+ {
+ DetailWriter.AddObject("Record", CbObject(SharedBuffer(ExistingValue.Value)));
+ }
+ OutPutResult = PutResult{zen::PutStatus::Conflict, DetailWriter.Save()};
return true;
}
}
diff --git a/src/zenstore/cache/cacherpc.cpp b/src/zenstore/cache/cacherpc.cpp
index 83301f863..e4f23816d 100644
--- a/src/zenstore/cache/cacherpc.cpp
+++ b/src/zenstore/cache/cacherpc.cpp
@@ -310,7 +310,7 @@ CacheRpcHandler::HandleRpcPutCacheRecords(const CacheRequestContext& Context, co
}
DefaultPolicy = !PolicyText.empty() ? ParseCachePolicy(PolicyText) : CachePolicy::Default;
- eastl::fixed_vector<bool, 32> Results;
+ eastl::fixed_vector<ZenCacheStore::PutResult, 32> Results;
CbArrayView RequestsArray = Params["Requests"sv].AsArrayView();
for (CbFieldView RequestField : RequestsArray)
@@ -332,33 +332,50 @@ CacheRpcHandler::HandleRpcPutCacheRecords(const CacheRequestContext& Context, co
.Policy = std::move(Policy),
.Context = Context};
- PutStatus Result = PutCacheRecord(PutRequest, &BatchRequest);
+ ZenCacheStore::PutResult Result = PutCacheRecord(PutRequest, &BatchRequest);
- if (Result == PutStatus::Invalid)
+ if (Result.Status == PutStatus::Invalid)
{
return CbPackage{};
}
- Results.push_back(Result == PutStatus::Success);
+ Results.push_back(Result);
}
if (Results.empty())
{
return CbPackage{};
}
+ bool bWriteAllDetails = false;
CbObjectWriter ResponseObject{256};
ResponseObject.BeginArray("Result"sv);
- for (bool Value : Results)
+ for (const ZenCacheStore::PutResult& Result : Results)
{
- ResponseObject.AddBool(Value);
+ // Conflicts will be treated for response purposes
+ // as successful puts because the key is present in the cache.
+ ResponseObject.AddBool((Result.Status == PutStatus::Success) || (Result.Status == PutStatus::Conflict));
+ if (Result.Details)
+ {
+ bWriteAllDetails = true;
+ }
}
ResponseObject.EndArray();
+ if (bWriteAllDetails)
+ {
+ ResponseObject.BeginArray("Details"sv);
+ for (const ZenCacheStore::PutResult& Result : Results)
+ {
+ ResponseObject.AddObject(Result.Details);
+ }
+ ResponseObject.EndArray();
+ }
+
CbPackage RpcResponse;
RpcResponse.SetObject(ResponseObject.Save());
return RpcResponse;
}
-PutStatus
+ZenCacheStore::PutResult
CacheRpcHandler::PutCacheRecord(PutRequestData& Request, const CbPackage* Package)
{
CbObjectView Record = Request.RecordObject;
@@ -420,7 +437,9 @@ CacheRpcHandler::PutCacheRecord(PutRequestData& Request, const CbPackage* Packag
if (Count.Invalid > 0)
{
- return PutStatus::Invalid;
+ CbObjectWriter DetailWriter;
+ DetailWriter.AddString("Message", fmt::format("Found {}/{} invalid attachments", Count.Invalid, Count.Total));
+ return ZenCacheStore::PutResult{PutStatus::Invalid, DetailWriter.Save()};
}
ZenCacheValue CacheValue;
@@ -440,7 +459,7 @@ CacheRpcHandler::PutCacheRecord(PutRequestData& Request, const CbPackage* Packag
nullptr);
if (PutResult.Status != zen::PutStatus::Success)
{
- return PutResult.Status;
+ return PutResult;
}
m_CacheStats.WriteCount++;
@@ -478,7 +497,7 @@ CacheRpcHandler::PutCacheRecord(PutRequestData& Request, const CbPackage* Packag
.Key = Request.Key,
.ValueContentIds = std::move(ValidAttachments)});
}
- return PutStatus::Success;
+ return PutResult;
}
CbPackage
@@ -841,14 +860,10 @@ CacheRpcHandler::HandleRpcGetCacheRecords(const CacheRequestContext& Context, Cb
Key.Hash);
}
}
- if (!Value.Exists && !EnumHasAllFlags(ValuePolicy, CachePolicy::SkipData))
+ if (!Value.Exists)
{
Request.Complete = false;
}
- // Request.Complete does not need to be set to false for upstream SkipData attachments.
- // In the PartialRecord==false case, the upstream will have failed the entire record if any SkipData attachment
- // didn't exist and we will not get here. In the PartialRecord==true case, we do not need to inform the client of
- // any missing SkipData attachments.
}
Request.ElapsedTimeUs += Timer.GetElapsedTimeUs();
}
@@ -864,7 +879,9 @@ CacheRpcHandler::HandleRpcGetCacheRecords(const CacheRequestContext& Context, Cb
ResponsePackage.ReserveAttachments(Requests.size());
+ eastl::fixed_vector<size_t, 4> IncompleteResultIndexes;
ResponseObject.BeginArray("Result"sv);
+ size_t ResultIndex = 0;
for (RecordRequestData& Request : Requests)
{
const CacheKey& Key = Request.Key;
@@ -880,6 +897,12 @@ CacheRpcHandler::HandleRpcGetCacheRecords(const CacheRequestContext& Context, Cb
}
}
+ if (!Request.Complete)
+ {
+ // If requesting a partial record, report back that the record overall is incomplete to the client
+ IncompleteResultIndexes.push_back(ResultIndex);
+ }
+
ZEN_DEBUG("GETCACHERECORD HIT - '{}/{}/{}' {}{} ({}) in {}",
*Namespace,
Key.Bucket,
@@ -916,8 +939,37 @@ CacheRpcHandler::HandleRpcGetCacheRecords(const CacheRequestContext& Context, Cb
m_CacheStats.MissCount++;
}
}
+ ++ResultIndex;
}
ResponseObject.EndArray();
+
+ if (!IncompleteResultIndexes.empty())
+ {
+ size_t IndexIntoIncompleteResultArray = 0;
+ size_t IncompleteResultIndex = IncompleteResultIndexes[IndexIntoIncompleteResultArray];
+ ResultIndex = 0;
+ ResponseObject.BeginArray("Incomplete"sv);
+ for (ResultIndex = 0; ResultIndex < Requests.size(); ++ResultIndex)
+ {
+ if (IncompleteResultIndex == ResultIndex)
+ {
+ ResponseObject.AddBool(true);
+ if (++IndexIntoIncompleteResultArray >= IncompleteResultIndexes.size())
+ {
+ IncompleteResultIndex = (size_t)-1;
+ }
+ else
+ {
+ IncompleteResultIndex = IncompleteResultIndexes[IndexIntoIncompleteResultArray];
+ }
+ }
+ else
+ {
+ ResponseObject.AddBool(true);
+ }
+ }
+ ResponseObject.EndArray();
+ }
ResponsePackage.SetObject(ResponseObject.Save());
return ResponsePackage;
}
@@ -1048,7 +1100,9 @@ CacheRpcHandler::HandleRpcPutCacheValues(const CacheRequestContext& Context, con
}
else
{
- Results.push_back({zen::PutStatus::Fail, fmt::format("Missing attachment with raw hash {}", RawHash)});
+ CbObjectWriter DetailWriter;
+ DetailWriter.AddString("Message", fmt::format("Missing attachment with raw hash {}", RawHash));
+ Results.push_back({zen::PutStatus::Fail, DetailWriter.Save()});
}
}
// We do not search the Upstream. No data in a put means the caller is probing for whether they need to do a heavy put.
@@ -1099,29 +1153,32 @@ CacheRpcHandler::HandleRpcPutCacheValues(const CacheRequestContext& Context, con
ZEN_TRACE_CPU("Z$::RpcPutCacheValues::Response");
CbObjectWriter ResponseObject{1024};
ResponseObject.BeginArray("Result"sv);
- bool bAnyErrors = false;
+ bool bWriteAllDetails = false;
for (const ZenCacheStore::PutResult& Value : Results)
{
- if (Value.Status == zen::PutStatus::Success)
+ // Conflicts will be treated for response purposes
+ // as successful puts because the key is present in the cache.
+ if ((Value.Status == zen::PutStatus::Success) || (Value.Status == zen::PutStatus::Conflict))
{
ResponseObject.AddBool(true);
}
else
{
- bAnyErrors = true;
ResponseObject.AddBool(false);
}
+ // If one result has details, we must write all details
+ if (Value.Details)
+ {
+ bWriteAllDetails = true;
+ }
}
ResponseObject.EndArray();
- if (bAnyErrors)
+ if (bWriteAllDetails)
{
- ResponseObject.BeginArray("ErrorMessages"sv);
+ ResponseObject.BeginArray("Details"sv);
for (const ZenCacheStore::PutResult& Value : Results)
{
- if (Value.Status != zen::PutStatus::Success)
- {
- ResponseObject.AddString(Value.Message);
- }
+ ResponseObject.AddObject(Value.Details);
}
ResponseObject.EndArray();
}
diff --git a/src/zenstore/cache/structuredcachestore.cpp b/src/zenstore/cache/structuredcachestore.cpp
index 3f27e6d21..b58f70ea7 100644
--- a/src/zenstore/cache/structuredcachestore.cpp
+++ b/src/zenstore/cache/structuredcachestore.cpp
@@ -730,7 +730,9 @@ ZenCacheStore::Put(const CacheRequestContext& Context,
if (IsKnownBadBucketName(Bucket))
{
m_RejectedWriteCount++;
- return PutResult{zen::PutStatus::Invalid, "Bad bucket name"};
+ CbObjectWriter DetailWriter;
+ DetailWriter.AddString("Message", "Bad bucket name");
+ return PutResult{zen::PutStatus::Invalid, DetailWriter.Save()};
}
ZEN_MEMSCOPE(GetCacheStoreTag());
@@ -777,7 +779,10 @@ ZenCacheStore::Put(const CacheRequestContext& Context,
Namespace,
Bucket,
HashKey.ToHexString());
- return PutResult{zen::PutStatus::Fail, fmt::format("Unknown namespace '{}'", Namespace)};
+
+ CbObjectWriter DetailWriter;
+ DetailWriter.AddString("Message", fmt::format("Unknown namespace '{}'", Namespace));
+ return PutResult{zen::PutStatus::Fail, DetailWriter.Save()};
}
bool
diff --git a/src/zenstore/include/zenstore/cache/cachedisklayer.h b/src/zenstore/include/zenstore/cache/cachedisklayer.h
index 49c52f847..10c61681b 100644
--- a/src/zenstore/include/zenstore/cache/cachedisklayer.h
+++ b/src/zenstore/include/zenstore/cache/cachedisklayer.h
@@ -4,6 +4,7 @@
#include "cacheshared.h"
+#include <zencore/compactbinary.h>
#include <zencore/stats.h>
#include <zenstore/accesstime.h>
#include <zenstore/blockstore.h>
@@ -180,7 +181,7 @@ public:
struct PutResult
{
zen::PutStatus Status;
- std::string Message;
+ CbObject Details;
};
explicit ZenCacheDiskLayer(GcManager& Gc, JobQueue& JobQueue, const std::filesystem::path& RootDir, const Configuration& Config);
diff --git a/src/zenstore/include/zenstore/cache/cacherpc.h b/src/zenstore/include/zenstore/cache/cacherpc.h
index 104746aba..e0c8738ca 100644
--- a/src/zenstore/include/zenstore/cache/cacherpc.h
+++ b/src/zenstore/include/zenstore/cache/cacherpc.h
@@ -5,6 +5,7 @@
#include <zencore/iobuffer.h>
#include <zencore/logging.h>
#include <zenstore/cache/cacheshared.h>
+#include <zenstore/cache/structuredcachestore.h>
#include <zenutil/cache/cache.h>
#include <atomic>
@@ -28,7 +29,6 @@ class CidStore;
class DiskWriteBlocker;
class HttpStructuredCacheService;
class UpstreamCacheClient;
-class ZenCacheStore;
enum class CachePolicy : uint32_t;
enum class RpcAcceptOptions : uint16_t;
@@ -101,7 +101,7 @@ private:
CbPackage HandleRpcGetCacheValues(const CacheRequestContext& Context, CbObjectView BatchRequest);
CbPackage HandleRpcGetCacheChunks(const CacheRequestContext& Context, RpcAcceptOptions AcceptOptions, CbObjectView BatchRequest);
- PutStatus PutCacheRecord(PutRequestData& Request, const CbPackage* Package);
+ ZenCacheStore::PutResult PutCacheRecord(PutRequestData& Request, const CbPackage* Package);
/** HandleRpcGetCacheChunks Helper: Parse the Body object into RecordValue Requests and Value Requests. */
bool ParseGetCacheChunksRequest(std::string& Namespace,
diff --git a/src/zenutil/cache/cacherequests.cpp b/src/zenutil/cache/cacherequests.cpp
index 7c6f493f2..b8169182d 100644
--- a/src/zenutil/cache/cacherequests.cpp
+++ b/src/zenutil/cache/cacherequests.cpp
@@ -313,6 +313,17 @@ namespace cacherequests {
Success.push_back(It.AsBool());
It++;
}
+
+ CbArrayView DetailsArray = Package.GetObject()["Details"].AsArrayView();
+ if (DetailsArray)
+ {
+ It = DetailsArray.CreateViewIterator();
+ while (It.HasValue())
+ {
+ Details.push_back(It.AsObjectView());
+ It++;
+ }
+ }
return true;
}
@@ -325,7 +336,15 @@ namespace cacherequests {
ResponseObject.AddBool(Value);
}
ResponseObject.EndArray();
-
+ if (!Details.empty())
+ {
+ ResponseObject.BeginArray("Details");
+ for (CbObjectView Value : Details)
+ {
+ ResponseObject.AddObject(Value);
+ }
+ ResponseObject.EndArray();
+ }
OutPackage.SetObject(ResponseObject.Save());
return true;
}
diff --git a/src/zenutil/include/zenutil/cache/cacherequests.h b/src/zenutil/include/zenutil/cache/cacherequests.h
index fbf3e08cc..2842e29f0 100644
--- a/src/zenutil/include/zenutil/cache/cacherequests.h
+++ b/src/zenutil/include/zenutil/cache/cacherequests.h
@@ -85,7 +85,8 @@ namespace cacherequests {
struct PutCacheRecordsResult
{
- std::vector<bool> Success;
+ std::vector<bool> Success;
+ std::vector<CbObjectView> Details;
bool Parse(const CbPackage& Package);
bool Format(CbPackage& OutPackage) const;
generated by cgit v1.2.3 (git 2.25.1) at 2026-03-13 07:28:18 +0000