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
|
/**
* Copyright (C) 2014 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include <map>
#include <string>
#include "mongo/base/status_with.h"
#include "mongo/base/string_data.h"
#include "mongo/bson/timestamp.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/storage/journal_listener.h"
#include "mongo/db/storage/kv/kv_catalog.h"
#include "mongo/db/storage/kv/kv_database_catalog_entry_base.h"
#include "mongo/db/storage/record_store.h"
#include "mongo/db/storage/storage_engine.h"
#include "mongo/stdx/functional.h"
#include "mongo/stdx/memory.h"
#include "mongo/stdx/mutex.h"
namespace mongo {
class KVCatalog;
class KVEngine;
struct KVStorageEngineOptions {
bool directoryPerDB = false;
bool directoryForIndexes = false;
bool forRepair = false;
};
/*
* The actual definition for this function is in
* `src/mongo/db/storage/kv/kv_database_catalog_entry.cpp` This unusual forward declaration is to
* facilitate better linker error messages. Tests need to pass a mock construction factory, whereas
* main implementations should pass the `default...` factory which is linked in with the main
* `KVDatabaseCatalogEntry` code.
*/
std::unique_ptr<KVDatabaseCatalogEntryBase> defaultDatabaseCatalogEntryFactory(
const StringData name, KVStorageEngine* const engine);
using KVDatabaseCatalogEntryFactory = decltype(defaultDatabaseCatalogEntryFactory);
class KVStorageEngine final : public StorageEngine {
public:
/**
* @param engine - ownership passes to me
*/
KVStorageEngine(KVEngine* engine,
const KVStorageEngineOptions& options = KVStorageEngineOptions(),
stdx::function<KVDatabaseCatalogEntryFactory> databaseCatalogEntryFactory =
defaultDatabaseCatalogEntryFactory);
virtual ~KVStorageEngine();
virtual void finishInit();
virtual RecoveryUnit* newRecoveryUnit();
virtual void listDatabases(std::vector<std::string>* out) const;
KVDatabaseCatalogEntryBase* getDatabaseCatalogEntry(OperationContext* opCtx,
StringData db) override;
virtual bool supportsDocLocking() const {
return _supportsDocLocking;
}
virtual bool supportsDBLocking() const {
return _supportsDBLocking;
}
virtual bool supportsCappedCollections() const {
return _supportsCappedCollections;
}
virtual Status closeDatabase(OperationContext* opCtx, StringData db);
virtual Status dropDatabase(OperationContext* opCtx, StringData db);
virtual int flushAllFiles(OperationContext* opCtx, bool sync);
virtual Status beginBackup(OperationContext* opCtx);
virtual void endBackup(OperationContext* opCtx);
virtual StatusWith<std::vector<std::string>> beginNonBlockingBackup(OperationContext* opCtx);
virtual void endNonBlockingBackup(OperationContext* opCtx);
virtual bool isDurable() const;
virtual bool isEphemeral() const;
virtual Status repairRecordStore(OperationContext* opCtx, const std::string& ns);
virtual void cleanShutdown();
virtual void setStableTimestamp(Timestamp stableTimestamp) override;
virtual void setInitialDataTimestamp(Timestamp initialDataTimestamp) override;
virtual void setOldestTimestampFromStable() override;
virtual void setOldestTimestamp(Timestamp newOldestTimestamp) override;
virtual bool isCacheUnderPressure(OperationContext* opCtx) const override;
virtual void setCachePressureForTest(int pressure) override;
virtual bool supportsRecoverToStableTimestamp() const override;
virtual StatusWith<Timestamp> recoverToStableTimestamp(OperationContext* opCtx) override;
virtual boost::optional<Timestamp> getRecoveryTimestamp() const override;
virtual boost::optional<Timestamp> getLastStableRecoveryTimestamp() const override;
virtual Timestamp getAllCommittedTimestamp() const override;
bool supportsReadConcernSnapshot() const final;
virtual void replicationBatchIsComplete() const override;
SnapshotManager* getSnapshotManager() const final;
void setJournalListener(JournalListener* jl) final;
// ------ kv ------
KVEngine* getEngine() {
return _engine.get();
}
const KVEngine* getEngine() const {
return _engine.get();
}
KVCatalog* getCatalog() {
return _catalog.get();
}
const KVCatalog* getCatalog() const {
return _catalog.get();
}
/**
* Drop abandoned idents. Returns a parallel list of index name, index spec pairs to rebuild.
*/
StatusWith<std::vector<StorageEngine::CollectionIndexNamePair>> reconcileCatalogAndIdents(
OperationContext* opCtx) override;
/**
* When loading after an unclean shutdown, this performs cleanup on the KVCatalog and unsets the
* startingAfterUncleanShutdown decoration on the global ServiceContext.
*/
void loadCatalog(OperationContext* opCtx) final;
void closeCatalog(OperationContext* opCtx) final;
private:
using CollIter = std::list<std::string>::iterator;
Status _dropCollectionsNoTimestamp(OperationContext* opCtx,
KVDatabaseCatalogEntryBase* dbce,
CollIter begin,
CollIter end);
Status _dropCollectionsWithTimestamp(OperationContext* opCtx,
KVDatabaseCatalogEntryBase* dbce,
std::list<std::string>& toDrop,
CollIter begin,
CollIter end);
/**
* When called in a repair context (_options.forRepair=true), attempts to recover a collection
* whose entry is present in the KVCatalog, but missing from the KVEngine. Returns an error
* Status if called outside of a repair context or the implementation of
* KVEngine::recoverOrphanedIdent returns an error other than DataModifiedByRepair.
*
* Returns Status::OK if the collection was recovered in the KVEngine and a new record store was
* created. Recovery does not make any guarantees about the integrity of the data in the
* collection.
*/
Status _recoverOrphanedCollection(OperationContext* opCtx,
const NamespaceString& collectionName,
StringData collectionIdent);
void _dumpCatalog(OperationContext* opCtx);
class RemoveDBChange;
stdx::function<KVDatabaseCatalogEntryFactory> _databaseCatalogEntryFactory;
KVStorageEngineOptions _options;
// This must be the first member so it is destroyed last.
std::unique_ptr<KVEngine> _engine;
const bool _supportsDocLocking;
const bool _supportsDBLocking;
const bool _supportsCappedCollections;
Timestamp _initialDataTimestamp = Timestamp::kAllowUnstableCheckpointsSentinel;
std::unique_ptr<RecordStore> _catalogRecordStore;
std::unique_ptr<KVCatalog> _catalog;
typedef std::map<std::string, KVDatabaseCatalogEntryBase*> DBMap;
DBMap _dbs;
mutable stdx::mutex _dbsLock;
// Flag variable that states if the storage engine is in backup mode.
bool _inBackupMode = false;
};
} // namespace mongo
|
