1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include <zencore/iobuffer.h>
#include <zencore/iohash.h>
#include <zencore/zencore.h>
#include <zenutil/cache/cache.h>
#include <atomic>
#include <chrono>
#include <functional>
#include <memory>
namespace zen {
class CbObjectView;
class CbPackage;
class CbObjectWriter;
class CidStore;
class ZenCacheStore;
struct CloudCacheClientOptions;
struct ZenStructuredCacheClientOptions;
struct UpstreamCacheRecord
{
ZenContentType Type = ZenContentType::kBinary;
CacheKey CacheKey;
std::vector<IoHash> PayloadIds;
};
struct UpstreamCacheOptions
{
std::chrono::seconds HealthCheckInterval{5};
uint32_t ThreadCount = 4;
bool ReadUpstream = true;
bool WriteUpstream = true;
bool StatsEnabled = false;
};
struct UpstreamError
{
int32_t ErrorCode{};
std::string Reason{};
explicit operator bool() const { return ErrorCode != 0; }
};
struct GetUpstreamCacheResult
{
IoBuffer Value;
UpstreamError Error{};
int64_t Bytes{};
double ElapsedSeconds{};
bool Success = false;
};
struct PutUpstreamCacheResult
{
std::string Reason;
int64_t Bytes{};
double ElapsedSeconds{};
bool Success = false;
};
struct UpstreamEndpointHealth
{
std::string Reason;
bool Ok = false;
};
struct UpstreamEndpointStats
{
std::atomic_uint64_t HitCount{};
std::atomic_uint64_t MissCount{};
std::atomic_uint64_t UpCount{};
std::atomic_uint64_t ErrorCount{};
std::atomic<double> UpBytes{};
std::atomic<double> DownBytes{};
std::atomic<double> SecondsUp{};
std::atomic<double> SecondsDown{};
};
struct CacheRecordGetCompleteParams
{
const CacheKey& CacheKey;
size_t KeyIndex = ~size_t(0);
const CbObjectView& Record;
const CbPackage& Package;
};
using OnCacheRecordGetComplete = std::function<void(CacheRecordGetCompleteParams&&)>;
struct CachePayloadGetCompleteParams
{
const CacheChunkRequest& Request;
size_t RequestIndex{~size_t(0)};
IoBuffer Payload;
};
using OnCachePayloadGetComplete = std::function<void(CachePayloadGetCompleteParams&&)>;
/**
* The upstream endpont is responsible for handling upload/downloading of cache records.
*/
class UpstreamEndpoint
{
public:
virtual ~UpstreamEndpoint() = default;
virtual UpstreamEndpointHealth Initialize() = 0;
virtual bool IsHealthy() const = 0;
virtual UpstreamEndpointHealth CheckHealth() = 0;
virtual std::string_view DisplayName() const = 0;
virtual GetUpstreamCacheResult GetCacheRecord(CacheKey CacheKey, ZenContentType Type) = 0;
virtual GetUpstreamCacheResult GetCacheRecords(std::span<CacheKey> CacheKeys,
std::span<size_t> KeyIndex,
const CacheRecordPolicy& Policy,
OnCacheRecordGetComplete&& OnComplete) = 0;
virtual GetUpstreamCacheResult GetCachePayload(const CacheKey& CacheKey, const IoHash& PayloadId) = 0;
virtual GetUpstreamCacheResult GetCachePayloads(std::span<CacheChunkRequest> CacheChunkRequests,
std::span<size_t> RequestIndex,
OnCachePayloadGetComplete&& OnComplete) = 0;
virtual PutUpstreamCacheResult PutCacheRecord(const UpstreamCacheRecord& CacheRecord,
IoBuffer RecordValue,
std::span<IoBuffer const> Payloads) = 0;
virtual UpstreamEndpointStats& Stats() = 0;
};
/**
* Manages one or more upstream cache endpoints.
*/
class UpstreamCache
{
public:
virtual ~UpstreamCache() = default;
virtual bool Initialize() = 0;
virtual void RegisterEndpoint(std::unique_ptr<UpstreamEndpoint> Endpoint) = 0;
virtual GetUpstreamCacheResult GetCacheRecord(CacheKey CacheKey, ZenContentType Type) = 0;
virtual void GetCacheRecords(std::span<CacheKey> CacheKeys,
std::span<size_t> KeyIndex,
const CacheRecordPolicy& RecordPolicy,
OnCacheRecordGetComplete&& OnComplete) = 0;
virtual GetUpstreamCacheResult GetCachePayload(const CacheKey& CacheKey, const IoHash& PayloadId) = 0;
virtual void GetCachePayloads(std::span<CacheChunkRequest> CacheChunkRequests,
std::span<size_t> RequestIndex,
OnCachePayloadGetComplete&& OnComplete) = 0;
struct EnqueueResult
{
bool Success = false;
};
virtual EnqueueResult EnqueueUpstream(UpstreamCacheRecord CacheRecord) = 0;
virtual void GetStatus(CbObjectWriter& CbO) = 0;
};
std::unique_ptr<UpstreamCache> MakeUpstreamCache(const UpstreamCacheOptions& Options, ZenCacheStore& CacheStore, CidStore& CidStore);
std::unique_ptr<UpstreamEndpoint> MakeJupiterUpstreamEndpoint(const CloudCacheClientOptions& Options);
std::unique_ptr<UpstreamEndpoint> MakeZenUpstreamEndpoint(const ZenStructuredCacheClientOptions& Options);
} // namespace zen
|