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
|
// Copyright Epic Games, Inc. All Rights Reserved.
#include <zenstore/cas.h>
#include "compactcas.h"
#include <zencore/except.h>
#include <zencore/filesystem.h>
#include <zencore/fmtutils.h>
#include <zencore/logging.h>
#include <zencore/memory.h>
#include <zencore/string.h>
#include <zencore/thread.h>
#include <zencore/uid.h>
#include <xxhash.h>
#include <gsl/gsl-lite.hpp>
#include <filesystem>
#include <functional>
//////////////////////////////////////////////////////////////////////////
namespace zen {
uint32_t
CasLogFile::FileHeader::ComputeChecksum()
{
return XXH32(&this->Magic, sizeof(FileHeader) - 4, 0xC0C0'BABA);
}
CasLogFile::CasLogFile()
{
}
CasLogFile::~CasLogFile()
{
}
void
CasLogFile::Open(std::filesystem::path FileName, size_t RecordSize, Mode Mode)
{
m_RecordSize = RecordSize;
std::error_code Ec;
BasicFile::Mode FileMode = BasicFile::Mode::kRead;
switch (Mode)
{
case Mode::kWrite:
FileMode = BasicFile::Mode::kWrite;
break;
case Mode::kTruncate:
FileMode = BasicFile::Mode::kTruncate;
break;
}
m_File.Open(FileName, FileMode, Ec);
if (Ec)
{
throw std::system_error(Ec, fmt::format("Failed to open log file '{}'", FileName));
}
uint64_t AppendOffset = 0;
if ((Mode == Mode::kTruncate) || (m_File.FileSize() < sizeof(FileHeader)))
{
if (Mode == Mode::kRead)
{
throw std::runtime_error(fmt::format("Mangled log header (file to small) in '{}'", FileName));
}
// Initialize log by writing header
FileHeader Header = {.RecordSize = gsl::narrow<uint32_t>(RecordSize), .LogId = Oid::NewOid(), .ValidatedTail = 0};
memcpy(Header.Magic, FileHeader::MagicSequence, sizeof Header.Magic);
Header.Finalize();
m_File.Write(&Header, sizeof Header, 0);
AppendOffset = sizeof(FileHeader);
m_Header = Header;
}
else
{
// Validate header and log contents and prepare for appending/replay
FileHeader Header;
m_File.Read(&Header, sizeof Header, 0);
if ((0 != memcmp(Header.Magic, FileHeader::MagicSequence, sizeof Header.Magic)) || (Header.Checksum != Header.ComputeChecksum()))
{
throw std::runtime_error(fmt::format("Mangled log header (invalid header magic) in '{}'", FileName));
}
AppendOffset = m_File.FileSize();
// Adjust the offset to ensure we end up on a good boundary, in case there is some garbage appended
AppendOffset -= sizeof Header;
AppendOffset -= AppendOffset % RecordSize;
AppendOffset += sizeof Header;
m_Header = Header;
}
m_AppendOffset = AppendOffset;
}
void
CasLogFile::Close()
{
// TODO: update header and maybe add trailer
Flush();
m_File.Close();
}
uint64_t
CasLogFile::GetLogSize()
{
return m_File.FileSize();
}
uint64_t
CasLogFile::GetLogCount()
{
uint64_t LogFileSize = m_AppendOffset.load(std::memory_order_acquire);
if (LogFileSize < sizeof(FileHeader))
{
return 0;
}
const uint64_t LogBaseOffset = sizeof(FileHeader);
const size_t LogEntryCount = (LogFileSize - LogBaseOffset) / m_RecordSize;
return LogEntryCount;
}
void
CasLogFile::Replay(std::function<void(const void*)>&& Handler, uint64_t SkipEntryCount)
{
uint64_t LogFileSize = m_File.FileSize();
// Ensure we end up on a clean boundary
uint64_t LogBaseOffset = sizeof(FileHeader);
size_t LogEntryCount = (LogFileSize - LogBaseOffset) / m_RecordSize;
if (LogEntryCount <= SkipEntryCount)
{
return;
}
LogBaseOffset += SkipEntryCount * m_RecordSize;
LogEntryCount -= SkipEntryCount;
// This should really be streaming the data rather than just
// reading it into memory, though we don't tend to get very
// large logs so it may not matter
const uint64_t LogDataSize = LogEntryCount * m_RecordSize;
std::vector<uint8_t> ReadBuffer;
ReadBuffer.resize(LogDataSize);
m_File.Read(ReadBuffer.data(), LogDataSize, LogBaseOffset);
for (int i = 0; i < int(LogEntryCount); ++i)
{
Handler(ReadBuffer.data() + (i * m_RecordSize));
}
m_AppendOffset = LogBaseOffset + (m_RecordSize * LogEntryCount);
}
void
CasLogFile::Append(const void* DataPointer, uint64_t DataSize)
{
ZEN_ASSERT((DataSize % m_RecordSize) == 0);
uint64_t AppendOffset = m_AppendOffset.fetch_add(DataSize);
std::error_code Ec;
m_File.Write(DataPointer, gsl::narrow<uint32_t>(DataSize), AppendOffset, Ec);
if (Ec)
{
throw std::system_error(Ec, fmt::format("Failed to write to log file '{}'", PathFromHandle(m_File.Handle())));
}
}
void
CasLogFile::Flush()
{
m_File.Flush();
}
} // namespace zen
|