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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include <zencore/compactbinary.h>
#include <zencore/compress.h>
#include <zencore/iobuffer.h>
#include <zencore/iohash.h>
#include <zencore/stats.h>
#include <zencore/zencore.h>
#include <zenutil/cache/cache.h>
#include <atomic>
#include <chrono>
#include <functional>
#include <memory>
#include <vector>
namespace zen {
class CbObjectView;
class AuthMgr;
class CbObjectView;
class CbPackage;
class CbObjectWriter;
class CidStore;
class ZenCacheStore;
struct CloudCacheClientOptions;
class CloudCacheTokenProvider;
struct ZenStructuredCacheClientOptions;
struct UpstreamCacheRecord
{
ZenContentType Type = ZenContentType::kBinary;
CacheKey Key;
std::vector<IoHash> ValueContentIds;
};
struct UpstreamCacheOptions
{
std::chrono::seconds HealthCheckInterval{5};
uint32_t ThreadCount = 4;
bool ReadUpstream = true;
bool WriteUpstream = true;
};
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 CacheRecordGetCompleteParams
{
CacheKeyRequest& Request;
const CbObjectView& Record;
const CbPackage& Package;
};
using OnCacheRecordGetComplete = std::function<void(CacheRecordGetCompleteParams&&)>;
struct CacheValueGetCompleteParams
{
CacheChunkRequest& Request;
IoHash RawHash;
uint64_t RawSize;
IoBuffer Value;
};
using OnCacheValueGetComplete = std::function<void(CacheValueGetCompleteParams&&)>;
struct UpstreamEndpointStats
{
metrics::OperationTiming CacheGetRequestTiming;
metrics::OperationTiming CachePutRequestTiming;
metrics::Counter CacheGetTotalBytes;
metrics::Counter CachePutTotalBytes;
metrics::Counter CacheGetCount;
metrics::Counter CacheHitCount;
metrics::Counter CacheErrorCount;
};
enum class UpstreamEndpointState : uint32_t
{
kDisabled,
kUnauthorized,
kError,
kOk
};
inline std::string_view
ToString(UpstreamEndpointState State)
{
using namespace std::literals;
switch (State)
{
case UpstreamEndpointState::kDisabled:
return "Disabled"sv;
case UpstreamEndpointState::kUnauthorized:
return "Unauthorized"sv;
case UpstreamEndpointState::kError:
return "Error"sv;
case UpstreamEndpointState::kOk:
return "Ok"sv;
default:
return "Unknown"sv;
}
}
struct UpstreamAuthConfig
{
std::string_view OAuthUrl;
std::string_view OAuthClientId;
std::string_view OAuthClientSecret;
std::string_view OpenIdProvider;
std::string_view AccessToken;
};
struct UpstreamEndpointStatus
{
std::string Reason;
UpstreamEndpointState State;
};
struct UpstreamEndpointInfo
{
std::string Name;
std::string Url;
};
/**
* The upstream endpoint is responsible for handling upload/downloading of cache records.
*/
class UpstreamEndpoint
{
public:
virtual ~UpstreamEndpoint() = default;
virtual UpstreamEndpointStatus Initialize() = 0;
virtual const UpstreamEndpointInfo& GetEndpointInfo() const = 0;
virtual UpstreamEndpointState GetState() = 0;
virtual UpstreamEndpointStatus GetStatus() = 0;
virtual GetUpstreamCacheResult GetCacheRecord(CacheKey CacheKey, ZenContentType Type) = 0;
virtual GetUpstreamCacheResult GetCacheRecords(std::span<CacheKeyRequest*> Requests, OnCacheRecordGetComplete&& OnComplete) = 0;
virtual GetUpstreamCacheResult GetCacheValue(const CacheKey& CacheKey, const IoHash& PayloadId) = 0;
virtual GetUpstreamCacheResult GetCacheValues(std::span<CacheChunkRequest*> CacheChunkRequests,
OnCacheValueGetComplete&& OnComplete) = 0;
virtual PutUpstreamCacheResult PutCacheRecord(const UpstreamCacheRecord& CacheRecord,
IoBuffer RecordValue,
std::span<IoBuffer const> Payloads) = 0;
virtual UpstreamEndpointStats& Stats() = 0;
static std::unique_ptr<UpstreamEndpoint> CreateZenEndpoint(const ZenStructuredCacheClientOptions& Options);
static std::unique_ptr<UpstreamEndpoint> CreateJupiterEndpoint(const CloudCacheClientOptions& Options,
const UpstreamAuthConfig& AuthConfig,
AuthMgr& Mgr);
};
/**
* Manages one or more upstream cache endpoints.
*/
class UpstreamCache
{
public:
virtual ~UpstreamCache() = default;
virtual void Initialize() = 0;
virtual void RegisterEndpoint(std::unique_ptr<UpstreamEndpoint> Endpoint) = 0;
virtual void IterateEndpoints(std::function<bool(UpstreamEndpoint&)>&& Fn) = 0;
virtual GetUpstreamCacheResult GetCacheRecord(CacheKey CacheKey, ZenContentType Type) = 0;
virtual void GetCacheRecords(std::span<CacheKeyRequest*> Requests, OnCacheRecordGetComplete&& OnComplete) = 0;
virtual GetUpstreamCacheResult GetCacheValue(const CacheKey& CacheKey, const IoHash& ValueContentId) = 0;
virtual void GetCacheValues(std::span<CacheChunkRequest*> CacheChunkRequests, OnCacheValueGetComplete&& OnComplete) = 0;
virtual void EnqueueUpstream(UpstreamCacheRecord CacheRecord) = 0;
virtual void GetStatus(CbObjectWriter& CbO) = 0;
static std::unique_ptr<UpstreamCache> Create(const UpstreamCacheOptions& Options, ZenCacheStore& CacheStore, CidStore& CidStore);
};
} // namespace zen
|