aboutsummaryrefslogtreecommitdiff
path: root/zenstore/cas.h
blob: 9c48d47071fa63ba53111e367091e2e2d5f9509f (plain) (blame)
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
// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include <zencore/blake3.h>
#include <zencore/iobuffer.h>
#include <zencore/iohash.h>
#include <zencore/refcount.h>
#include <zencore/timer.h>
#include <zenstore/cidstore.h>
#include <zenstore/hashkeyset.h>

#include <atomic>
#include <filesystem>
#include <functional>
#include <memory>
#include <string>
#include <unordered_set>

namespace zen {

class GcContext;
class GcManager;
class ScrubContext;

/** Content Addressable Storage interface

  */

class CasStore
{
public:
	virtual ~CasStore() = default;

	const CidStoreConfiguration& Config() { return m_Config; }

	struct InsertResult
	{
		bool New = false;
	};

	enum class InsertMode
	{
		kCopyOnly,
		kMayBeMovedInPlace
	};

	virtual void		 Initialize(const CidStoreConfiguration& Config)													   = 0;
	virtual InsertResult InsertChunk(IoBuffer Data, const IoHash& ChunkHash, InsertMode Mode = InsertMode::kMayBeMovedInPlace) = 0;
	virtual IoBuffer	 FindChunk(const IoHash& ChunkHash)																	   = 0;
	virtual bool		 ContainsChunk(const IoHash& ChunkHash)																   = 0;
	virtual void		 FilterChunks(HashKeySet& InOutChunks)																   = 0;
	virtual void		 Flush()																							   = 0;
	virtual void		 Scrub(ScrubContext& Ctx)																			   = 0;
	virtual void		 GarbageCollect(GcContext& GcCtx)																	   = 0;
	virtual CidStoreSize TotalSize() const																					   = 0;

protected:
	CidStoreConfiguration m_Config;
	uint64_t			  m_LastScrubTime = 0;
};

ZENCORE_API std::unique_ptr<CasStore> CreateCasStore(GcManager& Gc);

void CAS_forcelink();

}  // namespace zen