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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* 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 Server Side 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 <limits>
#include <wiredtiger.h>
#include "mongo/base/status.h"
#include "mongo/base/status_with.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/db/namespace_string.h"
#include "mongo/util/assert_util.h"
namespace mongo {
class BSONObjBuilder;
class OperationContext;
class WiredTigerConfigParser;
class WiredTigerKVEngine;
class WiredTigerSession;
inline bool wt_keeptxnopen() {
return false;
}
Status wtRCToStatus_slow(int retCode, const char* prefix);
/**
* converts wiredtiger return codes to mongodb statuses.
*/
inline Status wtRCToStatus(int retCode, const char* prefix = nullptr) {
if (MONGO_likely(retCode == 0))
return Status::OK();
return wtRCToStatus_slow(retCode, prefix);
}
#define invariantWTOK(expression) \
do { \
int _invariantWTOK_retCode = expression; \
if (MONGO_unlikely(_invariantWTOK_retCode != 0)) { \
invariantOKFailed( \
#expression, wtRCToStatus(_invariantWTOK_retCode), __FILE__, __LINE__); \
} \
} while (false)
struct WiredTigerItem : public WT_ITEM {
WiredTigerItem(const void* d, size_t s) {
data = d;
size = s;
}
WiredTigerItem(const std::string& str) {
data = str.c_str();
size = str.size();
}
// NOTE: do not call Get() on a temporary.
// The pointer returned by Get() must not be allowed to live longer than *this.
WT_ITEM* Get() {
return this;
}
const WT_ITEM* Get() const {
return this;
}
};
/**
* Returns a WT_EVENT_HANDLER with MongoDB's default handlers.
* The default handlers just log so it is recommended that you consider calling them even if
* you are capturing the output.
*
* There is no default "close" handler. You only need to provide one if you need to call a
* destructor.
*/
class WiredTigerEventHandler : private WT_EVENT_HANDLER {
public:
WiredTigerEventHandler();
WT_EVENT_HANDLER* getWtEventHandler();
bool wasStartupSuccessful() {
return _startupSuccessful;
}
void setStartupSuccessful() {
_startupSuccessful = true;
}
private:
int suppressibleStartupErrorLog(WT_EVENT_HANDLER* handler,
WT_SESSION* sesion,
int errorCode,
const char* message);
bool _startupSuccessful = false;
};
class WiredTigerUtil {
WiredTigerUtil(const WiredTigerUtil&) = delete;
WiredTigerUtil& operator=(const WiredTigerUtil&) = delete;
private:
WiredTigerUtil();
public:
/**
* Fetch the type and source fields out of the colgroup metadata. 'tableUri' must be a
* valid table: uri.
*/
static void fetchTypeAndSourceURI(OperationContext* opCtx,
const std::string& tableUri,
std::string* type,
std::string* source);
/**
* Reads contents of table using URI and exports all keys to BSON as string elements.
* Additional, adds 'uri' field to output document. A filter can be specified to skip desired
* fields.
*/
static Status exportTableToBSON(WT_SESSION* s,
const std::string& uri,
const std::string& config,
BSONObjBuilder* bob);
static Status exportTableToBSON(WT_SESSION* s,
const std::string& uri,
const std::string& config,
BSONObjBuilder* bob,
const std::vector<std::string>& filter);
/**
* Appends information about the storage engine's currently available snapshots and the settings
* that affect that window of maintained history.
*
* "snapshot-window-settings" : {
* "cache pressure percentage threshold" : <num>,
* "current cache pressure percentage" : <num>,
* "total number of SnapshotTooOld errors" : <num>,
* "max target available snapshots window size in seconds" : <num>,
* "target available snapshots window size in seconds" : <num>,
* "current available snapshots window size in seconds" : <num>,
* "latest majority snapshot timestamp available" : <num>,
* "oldest majority snapshot timestamp available" : <num>
* }
*/
static void appendSnapshotWindowSettings(WiredTigerKVEngine* engine,
WiredTigerSession* session,
BSONObjBuilder* bob);
/**
* Gets entire metadata string for collection/index at URI with the provided session.
*/
static StatusWith<std::string> getMetadataRaw(WT_SESSION* session, StringData uri);
/**
* Gets entire metadata string for collection/index at URI.
*/
static StatusWith<std::string> getMetadata(OperationContext* opCtx, StringData uri);
/**
* Reads app_metadata for collection/index at URI as a BSON document.
*/
static Status getApplicationMetadata(OperationContext* opCtx,
StringData uri,
BSONObjBuilder* bob);
static StatusWith<BSONObj> getApplicationMetadata(OperationContext* opCtx, StringData uri);
/**
* Validates formatVersion in application metadata for 'uri'.
* Version must be numeric and be in the range [minimumVersion, maximumVersion].
* URI is used in error messages only. Returns actual version.
*/
static StatusWith<int64_t> checkApplicationMetadataFormatVersion(OperationContext* opCtx,
StringData uri,
int64_t minimumVersion,
int64_t maximumVersion);
/**
* Validates the 'configString' specified as a collection or index creation option.
*/
static Status checkTableCreationOptions(const BSONElement& configElem);
/**
* Reads individual statistics using URI.
* List of statistics keys WT_STAT_* can be found in wiredtiger.h.
*/
static StatusWith<int64_t> getStatisticsValue(WT_SESSION* session,
const std::string& uri,
const std::string& config,
int statisticsKey);
static int64_t getIdentSize(WT_SESSION* s, const std::string& uri);
/**
* Return amount of memory to use for the WiredTiger cache based on either the startup
* option chosen or the amount of available memory on the host.
*/
static size_t getCacheSizeMB(double requestedCacheSizeGB);
class ErrorAccumulator : public WT_EVENT_HANDLER {
public:
ErrorAccumulator(std::vector<std::string>* errors);
private:
static int onError(WT_EVENT_HANDLER* handler,
WT_SESSION* session,
int error,
const char* message);
using ErrorHandler = int (*)(WT_EVENT_HANDLER*, WT_SESSION*, int, const char*);
std::vector<std::string>* const _errors;
const ErrorHandler _defaultErrorHandler;
};
/**
* Calls WT_SESSION::validate() on a side-session to ensure that your current transaction
* isn't left in an invalid state.
*
* If errors is non-NULL, all error messages will be appended to the array.
*/
static int verifyTable(OperationContext* opCtx,
const std::string& uri,
std::vector<std::string>* errors = nullptr);
static bool useTableLogging(NamespaceString ns, bool replEnabled);
static Status setTableLogging(OperationContext* opCtx, const std::string& uri, bool on);
static Status setTableLogging(WT_SESSION* session, const std::string& uri, bool on);
/**
* Casts unsigned 64-bit statistics value to T.
* If original value exceeds maximum value of T, return max(T).
*/
template <typename T>
static T castStatisticsValue(uint64_t statisticsValue);
private:
/**
* Casts unsigned 64-bit statistics value to T.
* If original value exceeds 'maximumResultType', return 'maximumResultType'.
*/
template <typename T>
static T _castStatisticsValue(uint64_t statisticsValue, T maximumResultType);
};
class WiredTigerConfigParser {
WiredTigerConfigParser(const WiredTigerConfigParser&) = delete;
WiredTigerConfigParser& operator=(const WiredTigerConfigParser&) = delete;
public:
WiredTigerConfigParser(StringData config) {
invariantWTOK(
wiredtiger_config_parser_open(nullptr, config.rawData(), config.size(), &_parser));
}
WiredTigerConfigParser(const WT_CONFIG_ITEM& nested) {
invariant(nested.type == WT_CONFIG_ITEM::WT_CONFIG_ITEM_STRUCT);
invariantWTOK(wiredtiger_config_parser_open(nullptr, nested.str, nested.len, &_parser));
}
~WiredTigerConfigParser() {
invariantWTOK(_parser->close(_parser));
}
int next(WT_CONFIG_ITEM* key, WT_CONFIG_ITEM* value) {
return _parser->next(_parser, key, value);
}
int get(const char* key, WT_CONFIG_ITEM* value) {
return _parser->get(_parser, key, value);
}
private:
WT_CONFIG_PARSER* _parser;
};
// static
template <typename ResultType>
ResultType WiredTigerUtil::castStatisticsValue(uint64_t statisticsValue) {
return _castStatisticsValue<ResultType>(statisticsValue,
std::numeric_limits<ResultType>::max());
}
// static
template <typename ResultType>
ResultType WiredTigerUtil::_castStatisticsValue(uint64_t statisticsValue,
ResultType maximumResultType) {
return statisticsValue > static_cast<uint64_t>(maximumResultType)
? maximumResultType
: static_cast<ResultType>(statisticsValue);
}
} // namespace mongo
|