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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once
#include "idatastore.h"
#include "lid_info.h"
#include "writeablefilechunk.h"
#include <vespa/searchcommon/common/growstrategy.h>
#include <vespa/searchlib/common/tunefileinfo.h>
#include <vespa/searchlib/transactionlog/syncproxy.h>
#include <vespa/vespalib/datastore/atomic_value_wrapper.h>
#include <vespa/vespalib/util/atomic.h>
#include <vespa/vespalib/util/compressionconfig.h>
#include <vespa/vespalib/util/cpu_usage.h>
#include <vespa/vespalib/util/executor.h>
#include <vespa/vespalib/util/rcuvector.h>
#include <set>
namespace search {
namespace common { class FileHeaderContext; }
/**
* Simple data storage for byte arrays.
* A small integer key is associated with each byte array;
* a zero-sized array is equivalent to a removed key.
* Changes are held in memory until flush() is called.
* A sync token is associated with each flush().
**/
class LogDataStore : public IDataStore, public ISetLid, public IGetLid
{
private:
using NameId = FileChunk::NameId;
using FileId = FileChunk::FileId;
public:
using NameIdSet = std::set<NameId>;
using MonitorGuard = std::unique_lock<std::mutex>;
using CompressionConfig = vespalib::compression::CompressionConfig;
template <typename T>
using AtomicValueWrapper = vespalib::datastore::AtomicValueWrapper<T>;
class Config {
public:
Config();
Config & setMaxFileSize(size_t v) { _maxFileSize = v; return *this; }
Config & setMaxNumLids(size_t v) { _maxNumLids = v; return *this; }
Config & setMaxBucketSpread(double v) noexcept { _maxBucketSpread.store_relaxed(v); return *this; }
Config & setMinFileSizeFactor(double v) { _minFileSizeFactor = v; return *this; }
Config & compactCompression(CompressionConfig v) { _compactCompression = v; return *this; }
Config & setFileConfig(WriteableFileChunk::Config v) { _fileConfig = v; return *this; }
size_t getMaxFileSize() const { return _maxFileSize; }
double getMaxBucketSpread() const noexcept { return _maxBucketSpread.load_relaxed(); }
double getMinFileSizeFactor() const { return _minFileSizeFactor; }
uint32_t getMaxNumLids() const { return _maxNumLids; }
CompressionConfig compactCompression() const { return _compactCompression; }
const WriteableFileChunk::Config & getFileConfig() const { return _fileConfig; }
bool operator == (const Config &) const;
private:
size_t _maxFileSize;
AtomicValueWrapper<double> _maxBucketSpread;
double _minFileSizeFactor;
uint32_t _maxNumLids;
CompressionConfig _compactCompression;
WriteableFileChunk::Config _fileConfig;
};
public:
using ConstBufferRef = vespalib::ConstBufferRef;
/**
* Construct a log based data store.
* All files are stored in base directory.
*
* @param dirName The directory that will contain the data file.
* @param fileHeaderContext The file header context used to populate
* the generic file header with extra tags.
* The caller must keep it alive for the semantic
* lifetime of the log data store.
* @param tlSyncer Helper to sync transaction log to avoid
* it being behind the document store after a
* crash.
* The caller must keep it alive for the semantic
* lifetime of the log data store.
*/
LogDataStore(vespalib::Executor &executor, const vespalib::string &dirName, const Config & config,
const GrowStrategy &growStrategy, const TuneFileSummary &tune,
const search::common::FileHeaderContext &fileHeaderContext,
transactionlog::SyncProxy &tlSyncer, IBucketizer::SP bucketizer, bool readOnly = false);
~LogDataStore() override;
// Implements IDataStore API
ssize_t read(uint32_t lid, vespalib::DataBuffer & buffer) const override;
void read(const LidVector & lids, IBufferVisitor & visitor) const override;
void write(uint64_t serialNum, uint32_t lid, const void * buffer, size_t len) override;
void remove(uint64_t serialNum, uint32_t lid) override;
void flush(uint64_t syncToken) override;
uint64_t initFlush(uint64_t syncToken) override;
size_t memoryUsed() const override;
size_t memoryMeta() const override;
uint64_t lastSyncToken() const override;
uint64_t tentativeLastSyncToken() const override;
vespalib::system_time getLastFlushTime() const override;
size_t getDiskFootprint() const override;
size_t getDiskHeaderFootprint() const override;
size_t getDiskBloat() const override;
size_t getMaxSpreadAsBloat() const override;
void compactBloat(uint64_t syncToken) { compactWorst(syncToken, true); }
void compactSpread(uint64_t syncToken) { compactWorst(syncToken, false);}
const Config & getConfig() const { return _config; }
Config & getConfig() { return _config; }
void write(MonitorGuard guard, WriteableFileChunk & destination, uint64_t serialNum, uint32_t lid,
ConstBufferRef data, vespalib::CpuUsage::Category cpu_category);
void write(MonitorGuard guard, FileId destinationFileId, uint32_t lid, ConstBufferRef data);
/**
* This will spinn through the data and verify the content of both
* the '.dat' and the '.idx' files.
*
* @param reportOnly If set inconsitencies will be written to 'stderr'.
*/
void verify(bool reportOnly) const;
/**
* Visit all data found in data store.
*/
void accept(IDataStoreVisitor &visitor, IDataStoreVisitorProgress &visitorProgress, bool prune) override;
/**
* Return cost of visiting all data found in data store.
*/
double getVisitCost() const override;
// Implements IGetLid API
Guard getLidReadGuard() const override {
return _genHandler.takeGuard();
}
// Implements IGetLid API
IGetLid::unique_lock getLidGuard(uint32_t lid) const override {
(void) lid;
return IGetLid::unique_lock(_updateLock);
}
// Implements IGetLid API
LidInfo getLid(const Guard & guard, uint32_t lid) const override {
(void) guard;
if (lid < getDocIdLimit()) {
return vespalib::atomic::load_ref_acquire(_lidInfo.acquire_elem_ref(lid));
} else {
return {};
}
}
FileId getActiveFileId(const MonitorGuard & guard) const;
bool hasUpdateLock(const MonitorGuard & guard) const {
return (guard.mutex() == &_updateLock) && guard.owns_lock();
}
DataStoreStorageStats getStorageStats() const override;
vespalib::MemoryUsage getMemoryUsage() const override;
std::vector<DataStoreFileChunkStats> getFileChunkStats() const override;
void compactLidSpace(uint32_t wantedDocLidLimit) override;
bool canShrinkLidSpace() const override;
size_t getEstimatedShrinkLidSpaceGain() const override;
void shrinkLidSpace() override;
static NameIdSet findIncompleteCompactedFiles(const NameIdSet & partList);
NameIdSet getAllActiveFiles() const;
void reconfigure(const Config & config);
private:
class WrapVisitor;
class WrapVisitorProgress;
class FileChunkHolder;
void setLid(const ISetLid::unique_lock & guard, uint32_t lid, const LidInfo & lm) override;
void compactWorst(uint64_t syncToken, bool compactDiskBloat);
void compactFile(FileId chunkId);
using LidInfoVector = vespalib::RcuVector<uint64_t>;
using FileChunkVector = std::vector<FileChunk::UP>;
void updateLidMap(uint32_t lastFileChunkDocIdLimit);
void preload();
uint32_t getLastFileChunkDocIdLimit();
void verifyModificationTime(const NameIdSet & partList);
void eraseDanglingDatFiles(const NameIdSet &partList, const NameIdSet &datPartList);
NameIdSet eraseEmptyIdxFiles(NameIdSet partList);
NameIdSet eraseIncompleteCompactedFiles(NameIdSet partList);
void internalFlushAll();
NameIdSet scanDir(const vespalib::string &dir, const vespalib::string &suffix);
FileId allocateFileId(const MonitorGuard & guard);
void setNewFileChunk(const MonitorGuard & guard, FileChunk::UP fileChunk);
vespalib::string ls(const NameIdSet & partList);
WriteableFileChunk & getActive(const MonitorGuard & guard);
const WriteableFileChunk & getActive(const MonitorGuard & guard) const;
const FileChunk * getPrevActive(const MonitorGuard & guard) const;
void setActive(const MonitorGuard & guard, FileId fileId);
double getMaxBucketSpread() const;
FileChunk::UP createReadOnlyFile(FileId fileId, NameId nameId);
FileChunk::UP createWritableFile(FileId fileId, SerialNum serialNum);
FileChunk::UP createWritableFile(FileId fileId, SerialNum serialNum, NameId nameId);
vespalib::string createFileName(NameId id) const;
vespalib::string createDatFileName(NameId id) const;
vespalib::string createIdxFileName(NameId id) const;
void requireSpace(MonitorGuard guard, WriteableFileChunk & active, vespalib::CpuUsage::Category cpu_category);
bool isReadOnly() const { return _readOnly; }
void updateSerialNum();
size_t computeNumberOfSignificantBucketIdBits(const IBucketizer & bucketizer, FileId fileId) const;
/// Protect against compactWorst() dropping file chunk. Caller must hold _updateLock.
std::unique_ptr<FileChunkHolder> holdFileChunk(const MonitorGuard & guard, FileId fileId);
/// Drop protection against compactWorst() dropping file chunk.
void unholdFileChunk(FileId fileId);
bool canFileChunkBeDropped(const MonitorGuard & guard, FileId fileId) const;
SerialNum flushFile(MonitorGuard guard, WriteableFileChunk & file, SerialNum syncToken,
vespalib::CpuUsage::Category cpu_category);
SerialNum flushActive(SerialNum syncToken);
void flushActiveAndWait(SerialNum syncToken);
void flushFileAndWait(MonitorGuard guard, WriteableFileChunk & file, SerialNum syncToken);
SerialNum getMinLastPersistedSerialNum() const {
return (_fileChunks.empty() ? 0 : _fileChunks.back()->getLastPersistedSerialNum());
}
bool shouldCompactToActiveFile(size_t compactedSize) const;
std::pair<bool, FileId> findNextToCompact(bool compactDiskBloat);
void incGeneration();
bool canShrinkLidSpace(const MonitorGuard &guard) const;
using FileIdxVector = std::vector<FileId>;
Config _config;
TuneFileSummary _tune;
const search::common::FileHeaderContext &_fileHeaderContext;
mutable vespalib::GenerationHandler _genHandler;
LidInfoVector _lidInfo;
FileChunkVector _fileChunks;
vespalib::hash_map<uint32_t, uint32_t> _holdFileChunks;
FileId _active;
FileId _prevActive;
mutable std::mutex _updateLock;
bool _readOnly;
vespalib::Executor &_executor;
SerialNum _initFlushSyncToken;
transactionlog::SyncProxy &_tlSyncer;
IBucketizer::SP _bucketizer;
NameIdSet _currentlyCompacting;
uint64_t _compactLidSpaceGeneration;
};
} // namespace search
|
