/
wiredtiger_index.cpp
1786 lines (1502 loc) · 72.1 KB
/
wiredtiger_index.cpp
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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* 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.
*/
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kStorage
#include "mongo/platform/basic.h"
#include "mongo/db/storage/wiredtiger/wiredtiger_index.h"
#include <memory>
#include <set>
#include "mongo/base/checked_cast.h"
#include "mongo/db/catalog/index_catalog_entry.h"
#include "mongo/db/catalog/validate_results.h"
#include "mongo/db/concurrency/write_conflict_exception.h"
#include "mongo/db/global_settings.h"
#include "mongo/db/index/index_descriptor.h"
#include "mongo/db/json.h"
#include "mongo/db/repl/repl_settings.h"
#include "mongo/db/service_context.h"
#include "mongo/db/stats/resource_consumption_metrics.h"
#include "mongo/db/storage/index_entry_comparison.h"
#include "mongo/db/storage/storage_options.h"
#include "mongo/db/storage/wiredtiger/wiredtiger_cursor_helpers.h"
#include "mongo/db/storage/wiredtiger/wiredtiger_customization_hooks.h"
#include "mongo/db/storage/wiredtiger/wiredtiger_global_options.h"
#include "mongo/db/storage/wiredtiger/wiredtiger_record_store.h"
#include "mongo/db/storage/wiredtiger/wiredtiger_session_cache.h"
#include "mongo/db/storage/wiredtiger/wiredtiger_util.h"
#include "mongo/logv2/log.h"
#include "mongo/util/assert_util.h"
#include "mongo/util/fail_point.h"
#include "mongo/util/hex.h"
#include "mongo/util/str.h"
#include "mongo/util/testing_proctor.h"
#define TRACING_ENABLED 0
#define LOGV2_TRACE_CURSOR(ID, NAME, ...) \
if (TRACING_ENABLED) \
LOGV2(ID, \
"WT index ({index}) " #NAME, \
"index"_attr = reinterpret_cast<uint64_t>(&_idx), \
##__VA_ARGS__)
#define LOGV2_TRACE_INDEX(ID, NAME, ...) \
if (TRACING_ENABLED) \
LOGV2(ID, \
"WT index ({index}) " #NAME, \
"index"_attr = reinterpret_cast<uint64_t>(this), \
##__VA_ARGS__)
namespace mongo {
namespace {
MONGO_FAIL_POINT_DEFINE(WTCompactIndexEBUSY);
MONGO_FAIL_POINT_DEFINE(WTEmulateOutOfOrderNextIndexKey);
MONGO_FAIL_POINT_DEFINE(WTIndexPauseAfterSearchNear);
using std::string;
using std::vector;
static const WiredTigerItem emptyItem(nullptr, 0);
} // namespace
// Keystring format 7 was used in 3.3.6 - 3.3.8 development releases. 4.2 onwards, unique indexes
// can be either format version 11 or 12. On upgrading to 4.2, an existing format 6 unique index
// will upgrade to format 11 and an existing format 8 unique index will upgrade to format 12.
const int kDataFormatV1KeyStringV0IndexVersionV1 = 6;
const int kDataFormatV2KeyStringV1IndexVersionV2 = 8;
const int kDataFormatV3KeyStringV0UniqueIndexVersionV1 = 11;
const int kDataFormatV4KeyStringV1UniqueIndexVersionV2 = 12;
const int kMinimumIndexVersion = kDataFormatV1KeyStringV0IndexVersionV1;
const int kMaximumIndexVersion = kDataFormatV4KeyStringV1UniqueIndexVersionV2;
void WiredTigerIndex::setKey(WT_CURSOR* cursor, const WT_ITEM* item) {
cursor->set_key(cursor, item);
}
void WiredTigerIndex::getKey(OperationContext* opCtx, WT_CURSOR* cursor, WT_ITEM* key) {
invariantWTOK(cursor->get_key(cursor, key));
auto& metricsCollector = ResourceConsumption::MetricsCollector::get(opCtx);
metricsCollector.incrementOneIdxEntryRead(key->size);
}
// static
StatusWith<std::string> WiredTigerIndex::parseIndexOptions(const BSONObj& options) {
StringBuilder ss;
BSONForEach(elem, options) {
if (elem.fieldNameStringData() == "configString") {
Status status = WiredTigerUtil::checkTableCreationOptions(elem);
if (!status.isOK()) {
return status;
}
ss << elem.valueStringData() << ',';
} else {
// Return error on first unrecognized field.
return StatusWith<std::string>(ErrorCodes::InvalidOptions,
str::stream() << '\'' << elem.fieldNameStringData()
<< '\'' << " is not a supported option.");
}
}
return StatusWith<std::string>(ss.str());
}
// static
std::string WiredTigerIndex::generateAppMetadataString(const IndexDescriptor& desc) {
StringBuilder ss;
int keyStringVersion;
if (desc.unique() && !desc.isIdIndex()) {
keyStringVersion = desc.version() >= IndexDescriptor::IndexVersion::kV2
? kDataFormatV4KeyStringV1UniqueIndexVersionV2
: kDataFormatV3KeyStringV0UniqueIndexVersionV1;
} else {
keyStringVersion = desc.version() >= IndexDescriptor::IndexVersion::kV2
? kDataFormatV2KeyStringV1IndexVersionV2
: kDataFormatV1KeyStringV0IndexVersionV1;
}
// Index metadata
ss << ",app_metadata=("
<< "formatVersion=" << keyStringVersion << "),";
return (ss.str());
}
// static
StatusWith<std::string> WiredTigerIndex::generateCreateString(
const std::string& engineName,
const std::string& sysIndexConfig,
const std::string& collIndexConfig,
const NamespaceString& collectionNamespace,
const IndexDescriptor& desc) {
str::stream ss;
// Separate out a prefix and suffix in the default string. User configuration will override
// values in the prefix, but not values in the suffix. Page sizes are chosen so that index
// keys (up to 1024 bytes) will not overflow.
ss << "type=file,internal_page_max=16k,leaf_page_max=16k,";
ss << "checksum=on,";
if (wiredTigerGlobalOptions.useIndexPrefixCompression) {
ss << "prefix_compression=true,";
}
ss << WiredTigerCustomizationHooks::get(getGlobalServiceContext())
->getTableCreateConfig(collectionNamespace.ns());
ss << sysIndexConfig << ",";
ss << collIndexConfig << ",";
// Validate configuration object.
// Raise an error about unrecognized fields that may be introduced in newer versions of
// this storage engine.
// Ensure that 'configString' field is a string. Raise an error if this is not the case.
BSONElement storageEngineElement = desc.infoObj()["storageEngine"];
if (storageEngineElement.isABSONObj()) {
BSONObj storageEngine = storageEngineElement.Obj();
StatusWith<std::string> parseStatus =
parseIndexOptions(storageEngine.getObjectField(engineName));
if (!parseStatus.isOK()) {
return parseStatus;
}
if (!parseStatus.getValue().empty()) {
ss << "," << parseStatus.getValue();
}
}
// WARNING: No user-specified config can appear below this line. These options are required
// for correct behavior of the server.
// Indexes need to store the metadata for collation to work as expected.
ss << ",key_format=u";
ss << ",value_format=u";
// Index metadata
ss << generateAppMetadataString(desc);
bool replicatedWrites = getGlobalReplSettings().usingReplSets() ||
repl::ReplSettings::shouldRecoverFromOplogAsStandalone();
if (WiredTigerUtil::useTableLogging(collectionNamespace, replicatedWrites)) {
ss << "log=(enabled=true)";
} else {
ss << "log=(enabled=false)";
}
LOGV2_DEBUG(51779, 3, "index create string", "str"_attr = ss.ss.str());
return StatusWith<std::string>(ss);
}
int WiredTigerIndex::Create(OperationContext* opCtx,
const std::string& uri,
const std::string& config) {
// Don't use the session from the recovery unit: create should not be used in a transaction
WiredTigerSession session(WiredTigerRecoveryUnit::get(opCtx)->getSessionCache()->conn());
WT_SESSION* s = session.getSession();
LOGV2_DEBUG(
51780, 1, "create uri: {uri} config: {config}", "uri"_attr = uri, "config"_attr = config);
return s->create(s, uri.c_str(), config.c_str());
}
int WiredTigerIndex::Drop(OperationContext* opCtx, const std::string& uri) {
WiredTigerSession session(WiredTigerRecoveryUnit::get(opCtx)->getSessionCache()->conn());
WT_SESSION* s = session.getSession();
return s->drop(s, uri.c_str(), nullptr);
}
WiredTigerIndex::WiredTigerIndex(OperationContext* ctx,
const std::string& uri,
StringData ident,
KeyFormat rsKeyFormat,
const IndexDescriptor* desc,
bool isReadOnly)
: SortedDataInterface(ident,
_handleVersionInfo(ctx, uri, desc, isReadOnly),
Ordering::make(desc->keyPattern()),
rsKeyFormat),
_uri(uri),
_tableId(WiredTigerSession::genTableId()),
_desc(desc),
_indexName(desc->indexName()),
_keyPattern(desc->keyPattern()),
_collation(desc->collation()) {}
NamespaceString WiredTigerIndex::getCollectionNamespace(OperationContext* opCtx) const {
return _desc->getEntry()->getNSSFromCatalog(opCtx);
}
namespace {
void dassertRecordIdAtEnd(const KeyString::Value& keyString, KeyFormat keyFormat) {
if (!kDebugBuild) {
return;
}
RecordId rid;
if (keyFormat == KeyFormat::Long) {
rid = KeyString::decodeRecordIdLongAtEnd(keyString.getBuffer(), keyString.getSize());
} else {
rid = KeyString::decodeRecordIdStrAtEnd(keyString.getBuffer(), keyString.getSize());
}
invariant(rid.isValid(), rid.toString());
}
} // namespace
Status WiredTigerIndex::insert(OperationContext* opCtx,
const KeyString::Value& keyString,
bool dupsAllowed) {
dassert(opCtx->lockState()->isWriteLocked());
dassertRecordIdAtEnd(keyString, _rsKeyFormat);
LOGV2_TRACE_INDEX(20093, "KeyString: {keyString}", "keyString"_attr = keyString);
WiredTigerCursor curwrap(_uri, _tableId, false, opCtx);
curwrap.assertInActiveTxn();
WT_CURSOR* c = curwrap.get();
return _insert(opCtx, c, keyString, dupsAllowed);
}
void WiredTigerIndex::unindex(OperationContext* opCtx,
const KeyString::Value& keyString,
bool dupsAllowed) {
dassert(opCtx->lockState()->isWriteLocked());
dassertRecordIdAtEnd(keyString, _rsKeyFormat);
WiredTigerCursor curwrap(_uri, _tableId, false, opCtx);
curwrap.assertInActiveTxn();
WT_CURSOR* c = curwrap.get();
invariant(c);
_unindex(opCtx, c, keyString, dupsAllowed);
}
void WiredTigerIndex::fullValidate(OperationContext* opCtx,
long long* numKeysOut,
IndexValidateResults* fullResults) const {
dassert(opCtx->lockState()->isReadLocked());
if (fullResults && !WiredTigerRecoveryUnit::get(opCtx)->getSessionCache()->isEphemeral()) {
int err = WiredTigerUtil::verifyTable(opCtx, _uri, &(fullResults->errors));
if (err == EBUSY) {
std::string msg = str::stream()
<< "Could not complete validation of " << _uri << ". "
<< "This is a transient issue as the collection was actively "
"in use by other operations.";
LOGV2_WARNING(51781,
"Could not complete validation. This is a transient issue as "
"the collection was actively in use by other operations",
"uri"_attr = _uri);
fullResults->warnings.push_back(msg);
} else if (err) {
std::string msg = str::stream()
<< "verify() returned " << wiredtiger_strerror(err) << ". "
<< "This indicates structural damage. "
<< "Not examining individual index entries.";
LOGV2_ERROR(51782,
"verify() returned an error. This indicates structural damage. Not "
"examining individual index entries.",
"error"_attr = wiredtiger_strerror(err));
fullResults->errors.push_back(msg);
fullResults->valid = false;
return;
}
}
auto cursor = newCursor(opCtx);
long long count = 0;
LOGV2_TRACE_INDEX(20094, "fullValidate");
const auto requestedInfo = TRACING_ENABLED ? Cursor::kKeyAndLoc : Cursor::kJustExistance;
KeyString::Value keyStringForSeek =
IndexEntryComparison::makeKeyStringFromBSONKeyForSeek(BSONObj(),
getKeyStringVersion(),
getOrdering(),
true, /* forward */
true /* inclusive */
);
for (auto kv = cursor->seek(keyStringForSeek, requestedInfo); kv; kv = cursor->next()) {
LOGV2_TRACE_INDEX(20095, "fullValidate {kv}", "kv"_attr = kv);
count++;
}
if (numKeysOut) {
*numKeysOut = count;
}
}
bool WiredTigerIndex::appendCustomStats(OperationContext* opCtx,
BSONObjBuilder* output,
double scale) const {
dassert(opCtx->lockState()->isReadLocked());
{
BSONObjBuilder metadata(output->subobjStart("metadata"));
Status status = WiredTigerUtil::getApplicationMetadata(opCtx, uri(), &metadata);
if (!status.isOK()) {
metadata.append("error", "unable to retrieve metadata");
metadata.append("code", static_cast<int>(status.code()));
metadata.append("reason", status.reason());
}
}
std::string type, sourceURI;
WiredTigerUtil::fetchTypeAndSourceURI(opCtx, _uri, &type, &sourceURI);
StatusWith<std::string> metadataResult = WiredTigerUtil::getMetadataCreate(opCtx, sourceURI);
StringData creationStringName("creationString");
if (!metadataResult.isOK()) {
BSONObjBuilder creationString(output->subobjStart(creationStringName));
creationString.append("error", "unable to retrieve creation config");
creationString.append("code", static_cast<int>(metadataResult.getStatus().code()));
creationString.append("reason", metadataResult.getStatus().reason());
} else {
output->append(creationStringName, metadataResult.getValue());
// Type can be "lsm" or "file"
output->append("type", type);
}
WiredTigerSession* session = WiredTigerRecoveryUnit::get(opCtx)->getSession();
WT_SESSION* s = session->getSession();
Status status =
WiredTigerUtil::exportTableToBSON(s, "statistics:" + uri(), "statistics=(fast)", output);
if (!status.isOK()) {
output->append("error", "unable to retrieve statistics");
output->append("code", static_cast<int>(status.code()));
output->append("reason", status.reason());
}
return true;
}
Status WiredTigerIndex::dupKeyCheck(OperationContext* opCtx, const KeyString::Value& key) {
invariant(unique());
WiredTigerCursor curwrap(_uri, _tableId, false, opCtx);
WT_CURSOR* c = curwrap.get();
if (isDup(opCtx, c, key)) {
auto entry = _desc->getEntry();
auto nss = entry ? entry->getNSSFromCatalog(opCtx) : NamespaceString();
return buildDupKeyErrorStatus(key, nss, _indexName, _keyPattern, _collation, _ordering);
}
return Status::OK();
}
bool WiredTigerIndex::isEmpty(OperationContext* opCtx) {
WiredTigerCursor curwrap(_uri, _tableId, false, opCtx);
WT_CURSOR* c = curwrap.get();
if (!c)
return true;
int ret = wiredTigerPrepareConflictRetry(opCtx, [&] { return c->next(c); });
if (ret == WT_NOTFOUND)
return true;
invariantWTOK(ret);
return false;
}
long long WiredTigerIndex::getSpaceUsedBytes(OperationContext* opCtx) const {
dassert(opCtx->lockState()->isReadLocked());
auto ru = WiredTigerRecoveryUnit::get(opCtx);
WiredTigerSession* session = ru->getSession();
if (ru->getSessionCache()->isEphemeral()) {
// For ephemeral case, use cursor statistics
const auto statsUri = "statistics:" + uri();
// Helper function to retrieve stats and check for errors
auto getStats = [&](int key) -> int64_t {
auto result = WiredTigerUtil::getStatisticsValue(
session->getSession(), statsUri, "statistics=(fast)", key);
if (!result.isOK()) {
if (result.getStatus().code() == ErrorCodes::CursorNotFound)
return 0; // ident gone, so return 0
uassertStatusOK(result.getStatus());
}
return result.getValue();
};
auto inserts = getStats(WT_STAT_DSRC_CURSOR_INSERT);
auto removes = getStats(WT_STAT_DSRC_CURSOR_REMOVE);
auto insertBytes = getStats(WT_STAT_DSRC_CURSOR_INSERT_BYTES);
if (inserts == 0 || removes >= inserts)
return 0;
// Rough approximation of index size as average entry size times number of entries.
// May be off if key sizes change significantly over the life time of the collection,
// but is the best we can do currrently with the statistics available.
auto bytesPerEntry = (insertBytes + inserts - 1) / inserts; // round up
auto numEntries = inserts - removes;
return numEntries * bytesPerEntry;
}
return static_cast<long long>(WiredTigerUtil::getIdentSize(session->getSession(), _uri));
}
long long WiredTigerIndex::getFreeStorageBytes(OperationContext* opCtx) const {
dassert(opCtx->lockState()->isReadLocked());
auto ru = WiredTigerRecoveryUnit::get(opCtx);
WiredTigerSession* session = ru->getSession();
return static_cast<long long>(WiredTigerUtil::getIdentReuseSize(session->getSession(), _uri));
}
Status WiredTigerIndex::initAsEmpty(OperationContext* opCtx) {
// No-op
return Status::OK();
}
Status WiredTigerIndex::compact(OperationContext* opCtx) {
dassert(opCtx->lockState()->isWriteLocked());
WiredTigerSessionCache* cache = WiredTigerRecoveryUnit::get(opCtx)->getSessionCache();
if (!cache->isEphemeral()) {
WT_SESSION* s = WiredTigerRecoveryUnit::get(opCtx)->getSession()->getSession();
opCtx->recoveryUnit()->abandonSnapshot();
int ret = s->compact(s, uri().c_str(), "timeout=0");
if (MONGO_unlikely(WTCompactIndexEBUSY.shouldFail())) {
ret = EBUSY;
}
if (ret == EBUSY) {
return Status(ErrorCodes::Interrupted,
str::stream() << "Compaction interrupted on " << uri().c_str()
<< " due to cache eviction pressure");
}
invariantWTOK(ret);
}
return Status::OK();
}
KeyString::Version WiredTigerIndex::_handleVersionInfo(OperationContext* ctx,
const std::string& uri,
const IndexDescriptor* desc,
bool isReadOnly) {
auto version = WiredTigerUtil::checkApplicationMetadataFormatVersion(
ctx, uri, kMinimumIndexVersion, kMaximumIndexVersion);
if (!version.isOK()) {
auto collectionNamespace = desc->getEntry()->getNSSFromCatalog(ctx);
Status versionStatus = version.getStatus();
Status indexVersionStatus(ErrorCodes::UnsupportedFormat,
str::stream()
<< versionStatus.reason() << " Index: {name: "
<< desc->indexName() << ", ns: " << collectionNamespace
<< "} - version either too old or too new for this mongod.");
fassertFailedWithStatus(28579, indexVersionStatus);
}
_dataFormatVersion = version.getValue();
if (!desc->isIdIndex() && desc->unique() &&
_dataFormatVersion != kDataFormatV3KeyStringV0UniqueIndexVersionV1 &&
_dataFormatVersion != kDataFormatV4KeyStringV1UniqueIndexVersionV2) {
auto collectionNamespace = desc->getEntry()->getNSSFromCatalog(ctx);
Status versionStatus(ErrorCodes::UnsupportedFormat,
str::stream()
<< "Index: {name: " << desc->indexName()
<< ", ns: " << collectionNamespace
<< "} has incompatible format version: " << _dataFormatVersion);
fassertFailedWithStatusNoTrace(31179, versionStatus);
}
if (!isReadOnly) {
bool replicatedWrites = getGlobalReplSettings().usingReplSets() ||
repl::ReplSettings::shouldRecoverFromOplogAsStandalone();
bool useTableLogging = !replicatedWrites ||
WiredTigerUtil::useTableLogging(desc->getEntry()->getNSSFromCatalog(ctx),
replicatedWrites);
uassertStatusOK(WiredTigerUtil::setTableLogging(ctx, uri, useTableLogging));
}
/*
* Index data format 6 and 11 correspond to KeyString version V0 and data format 8 and 12
* correspond to KeyString version V1.
*/
return (_dataFormatVersion == kDataFormatV2KeyStringV1IndexVersionV2 ||
_dataFormatVersion == kDataFormatV4KeyStringV1UniqueIndexVersionV2)
? KeyString::Version::V1
: KeyString::Version::V0;
}
/**
* Base class for WiredTigerIndex bulk builders.
*
* Manages the bulk cursor used by bulk builders.
*/
class WiredTigerIndex::BulkBuilder : public SortedDataBuilderInterface {
public:
BulkBuilder(WiredTigerIndex* idx, OperationContext* opCtx)
: _ordering(idx->_ordering),
_opCtx(opCtx),
_session(WiredTigerRecoveryUnit::get(_opCtx)->getSessionCache()->getSession()),
_cursor(openBulkCursor(idx)) {}
~BulkBuilder() {
_cursor->close(_cursor);
}
protected:
WT_CURSOR* openBulkCursor(WiredTigerIndex* idx) {
// Open cursors can cause bulk open_cursor to fail with EBUSY.
// TODO any other cases that could cause EBUSY?
WiredTigerSession* outerSession = WiredTigerRecoveryUnit::get(_opCtx)->getSession();
outerSession->closeAllCursors(idx->uri());
// Not using cursor cache since we need to set "bulk".
WT_CURSOR* cursor;
// Use a different session to ensure we don't hijack an existing transaction.
// Configure the bulk cursor open to fail quickly if it would wait on a checkpoint
// completing - since checkpoints can take a long time, and waiting can result in
// an unexpected pause in building an index.
WT_SESSION* session = _session->getSession();
int err = session->open_cursor(
session, idx->uri().c_str(), nullptr, "bulk,checkpoint_wait=false", &cursor);
if (!err)
return cursor;
LOGV2_WARNING(51783,
"failed to create WiredTiger bulk cursor: {error} falling back to non-bulk "
"cursor for index {index}",
"Failed to create WiredTiger bulk cursor, falling back to non-bulk",
"error"_attr = wiredtiger_strerror(err),
"index"_attr = idx->uri());
invariantWTOK(session->open_cursor(session, idx->uri().c_str(), nullptr, nullptr, &cursor));
return cursor;
}
void setKey(WT_CURSOR* cursor, const WT_ITEM* item) {
cursor->set_key(cursor, item);
}
const Ordering _ordering;
OperationContext* const _opCtx;
UniqueWiredTigerSession const _session;
WT_CURSOR* const _cursor;
};
/**
* Bulk builds a non-unique index.
*/
class WiredTigerIndex::StandardBulkBuilder : public BulkBuilder {
public:
StandardBulkBuilder(WiredTigerIndex* idx, OperationContext* opCtx)
: BulkBuilder(idx, opCtx), _idx(idx) {}
Status addKey(const KeyString::Value& keyString) override {
dassertRecordIdAtEnd(keyString, _idx->rsKeyFormat());
// Can't use WiredTigerCursor since we aren't using the cache.
WiredTigerItem item(keyString.getBuffer(), keyString.getSize());
setKey(_cursor, item.Get());
const KeyString::TypeBits typeBits = keyString.getTypeBits();
WiredTigerItem valueItem = typeBits.isAllZeros()
? emptyItem
: WiredTigerItem(typeBits.getBuffer(), typeBits.getSize());
_cursor->set_value(_cursor, valueItem.Get());
invariantWTOK(wiredTigerCursorInsert(_opCtx, _cursor));
auto& metricsCollector = ResourceConsumption::MetricsCollector::get(_opCtx);
metricsCollector.incrementOneIdxEntryWritten(item.size);
return Status::OK();
}
private:
WiredTigerIndex* _idx;
};
/**
* Bulk builds a unique index.
*
* In order to support unique indexes in dupsAllowed mode this class only does an actual insert
* after it sees a key after the one we are trying to insert. This allows us to gather up all
* duplicate ids and insert them all together. This is necessary since bulk cursors can only
* append data.
*/
class WiredTigerIndex::UniqueBulkBuilder : public BulkBuilder {
public:
UniqueBulkBuilder(WiredTigerIndex* idx, OperationContext* opCtx, bool dupsAllowed)
: BulkBuilder(idx, opCtx),
_idx(idx),
_dupsAllowed(dupsAllowed),
_previousKeyString(idx->getKeyStringVersion()) {
invariant(!_idx->isIdIndex());
}
Status addKey(const KeyString::Value& newKeyString) override {
dassertRecordIdAtEnd(newKeyString, KeyFormat::Long);
// Do a duplicate check, but only if dups aren't allowed.
if (!_dupsAllowed) {
const int cmp = newKeyString.compareWithoutRecordIdLong(_previousKeyString);
if (cmp == 0) {
// Duplicate found!
auto newKey = KeyString::toBson(newKeyString, _idx->_ordering);
auto entry = _idx->_desc->getEntry();
return buildDupKeyErrorStatus(newKey,
entry ? entry->getNSSFromCatalog(_opCtx)
: NamespaceString(),
_idx->indexName(),
_idx->keyPattern(),
_idx->_collation);
} else {
/*
* _previousKeyString.isEmpty() is only true on the first call to addKey().
* newKeyString must be greater than previous key.
*/
invariant(_previousKeyString.isEmpty() || cmp > 0);
}
}
// Can't use WiredTigerCursor since we aren't using the cache.
WiredTigerItem keyItem(newKeyString.getBuffer(), newKeyString.getSize());
setKey(_cursor, keyItem.Get());
const KeyString::TypeBits typeBits = newKeyString.getTypeBits();
WiredTigerItem valueItem = typeBits.isAllZeros()
? emptyItem
: WiredTigerItem(typeBits.getBuffer(), typeBits.getSize());
_cursor->set_value(_cursor, valueItem.Get());
invariantWTOK(wiredTigerCursorInsert(_opCtx, _cursor));
auto& metricsCollector = ResourceConsumption::MetricsCollector::get(_opCtx);
metricsCollector.incrementOneIdxEntryWritten(keyItem.size);
// Don't copy the key again if dups are allowed.
if (!_dupsAllowed)
_previousKeyString.resetFromBuffer(newKeyString.getBuffer(), newKeyString.getSize());
return Status::OK();
}
private:
WiredTigerIndex* _idx;
const bool _dupsAllowed;
KeyString::Builder _previousKeyString;
};
class WiredTigerIndex::IdBulkBuilder : public BulkBuilder {
public:
IdBulkBuilder(WiredTigerIndex* idx, OperationContext* opCtx)
: BulkBuilder(idx, opCtx), _idx(idx), _previousKeyString(idx->getKeyStringVersion()) {
invariant(_idx->isIdIndex());
}
Status addKey(const KeyString::Value& newKeyString) override {
dassertRecordIdAtEnd(newKeyString, KeyFormat::Long);
const int cmp = newKeyString.compareWithoutRecordIdLong(_previousKeyString);
// _previousKeyString.isEmpty() is only true on the first call to addKey().
invariant(_previousKeyString.isEmpty() || cmp > 0);
RecordId id =
KeyString::decodeRecordIdLongAtEnd(newKeyString.getBuffer(), newKeyString.getSize());
KeyString::TypeBits typeBits = newKeyString.getTypeBits();
KeyString::Builder value(_idx->getKeyStringVersion());
value.appendRecordId(id);
// When there is only one record, we can omit AllZeros TypeBits. Otherwise they need
// to be included.
if (!typeBits.isAllZeros()) {
value.appendTypeBits(typeBits);
}
auto sizeWithoutRecordId = KeyString::sizeWithoutRecordIdLongAtEnd(newKeyString.getBuffer(),
newKeyString.getSize());
WiredTigerItem keyItem(newKeyString.getBuffer(), sizeWithoutRecordId);
WiredTigerItem valueItem(value.getBuffer(), value.getSize());
setKey(_cursor, keyItem.Get());
_cursor->set_value(_cursor, valueItem.Get());
invariantWTOK(wiredTigerCursorInsert(_opCtx, _cursor));
auto& metricsCollector = ResourceConsumption::MetricsCollector::get(_opCtx);
metricsCollector.incrementOneIdxEntryWritten(keyItem.size);
_previousKeyString.resetFromBuffer(newKeyString.getBuffer(), newKeyString.getSize());
return Status::OK();
}
private:
WiredTigerIndex* _idx;
KeyString::Builder _previousKeyString;
};
std::unique_ptr<SortedDataBuilderInterface> WiredTigerIdIndex::makeBulkBuilder(
OperationContext* opCtx, bool dupsAllowed) {
// Duplicates are not actually allowed on the _id index, however we accept the parameter
// regardless.
return std::make_unique<IdBulkBuilder>(this, opCtx);
}
namespace {
/**
* Implements the basic WT_CURSOR functionality used by both unique and standard indexes.
*/
class WiredTigerIndexCursorBase : public SortedDataInterface::Cursor {
public:
WiredTigerIndexCursorBase(const WiredTigerIndex& idx, OperationContext* opCtx, bool forward)
: _opCtx(opCtx),
_idx(idx),
_forward(forward),
_key(idx.getKeyStringVersion()),
_typeBits(idx.getKeyStringVersion()),
_query(idx.getKeyStringVersion()) {
_cursor.emplace(_idx.uri(), _idx.tableId(), false, _opCtx);
}
boost::optional<IndexKeyEntry> next(RequestedInfo parts) override {
if (!advanceNext()) {
return {};
}
return curr(parts);
}
boost::optional<KeyStringEntry> nextKeyString() override {
if (!advanceNext()) {
return {};
}
if (_eof) {
return {};
}
return getKeyStringEntry();
}
void setEndPosition(const BSONObj& key, bool inclusive) override {
LOGV2_TRACE_CURSOR(20098,
"setEndPosition inclusive: {inclusive} {key}",
"inclusive"_attr = inclusive,
"key"_attr = key);
if (key.isEmpty()) {
// This means scan to end of index.
_endPosition.reset();
return;
}
// NOTE: this uses the opposite rules as a normal seek because a forward scan should
// end after the key if inclusive and before if exclusive.
const auto discriminator = _forward == inclusive
? KeyString::Discriminator::kExclusiveAfter
: KeyString::Discriminator::kExclusiveBefore;
_endPosition = std::make_unique<KeyString::Builder>(_idx.getKeyStringVersion());
_endPosition->resetToKey(BSONObj::stripFieldNames(key), _idx.getOrdering(), discriminator);
}
boost::optional<IndexKeyEntry> seek(const KeyString::Value& keyString,
RequestedInfo parts = kKeyAndLoc) override {
seekForKeyString(keyString);
return curr(parts);
}
boost::optional<KeyStringEntry> seekForKeyString(
const KeyString::Value& keyStringValue) override {
dassert(_opCtx->lockState()->isReadLocked());
seekWTCursor(keyStringValue);
updatePosition();
if (_eof)
return {};
dassert(!atOrPastEndPointAfterSeeking());
dassert(!_id.isNull());
return getKeyStringEntry();
}
boost::optional<KeyStringEntry> seekExactForKeyString(const KeyString::Value& key) override {
dassert(KeyString::decodeDiscriminator(
key.getBuffer(), key.getSize(), _idx.getOrdering(), key.getTypeBits()) ==
KeyString::Discriminator::kInclusive);
auto ksEntry = [&]() {
if (_forward) {
return seekForKeyString(key);
}
// Append a kExclusiveAfter discriminator if it's a reverse cursor to ensure that the
// KeyString we construct will always be greater than the KeyString that we retrieve
// (even when it has a RecordId).
KeyString::Builder keyCopy(_idx.getKeyStringVersion(), _idx.getOrdering());
// Reset by copying all but the last byte, the kEnd byte.
keyCopy.resetFromBuffer(key.getBuffer(), key.getSize() - 1);
// Append a different discriminator and new end byte.
keyCopy.appendDiscriminator(KeyString::Discriminator::kExclusiveAfter);
return seekForKeyString(keyCopy.getValueCopy());
}();
if (!ksEntry) {
return {};
}
if (KeyString::compare(ksEntry->keyString.getBuffer(),
key.getBuffer(),
KeyString::sizeWithoutRecordIdLongAtEnd(
ksEntry->keyString.getBuffer(), ksEntry->keyString.getSize()),
key.getSize()) == 0) {
return KeyStringEntry(ksEntry->keyString, ksEntry->loc);
}
return {};
}
boost::optional<IndexKeyEntry> seekExact(const KeyString::Value& keyStringValue,
RequestedInfo parts) override {
auto ksEntry = seekExactForKeyString(keyStringValue);
if (ksEntry) {
auto kv = curr(parts);
invariant(kv);
return kv;
}
return {};
}
void save() override {
try {
if (_cursor)
_cursor->reset();
} catch (const WriteConflictException&) {
// Ignore since this is only called when we are about to kill our transaction
// anyway.
}
// Our saved position is wherever we were when we last called updatePosition().
// Any partially completed repositions should not effect our saved position.
}
void saveUnpositioned() override {
save();
_eof = true;
}
void restore() override {
if (!_cursor) {
_cursor.emplace(_idx.uri(), _idx.tableId(), false, _opCtx);
}
// Ensure an active session exists, so any restored cursors will bind to it
invariant(WiredTigerRecoveryUnit::get(_opCtx)->getSession() == _cursor->getSession());
if (!_eof) {
// Standard (non-unique) indices *do* include the record id in their KeyStrings. This
// means that restoring to the same key with a new record id will return false, and we
// will *not* skip the key with the new record id.
//
// Unique indexes can have both kinds of KeyStrings, ie with or without the record id.
// Restore for unique indexes gets handled separately in it's own implementation.
_lastMoveSkippedKey = !seekWTCursor(_key.getValueCopy());
LOGV2_TRACE_CURSOR(20099,
"restore _lastMoveSkippedKey: {lastMoveSkippedKey}",
"lastMoveSkippedKey"_attr = _lastMoveSkippedKey);
}
}
void detachFromOperationContext() final {
_opCtx = nullptr;
_cursor = boost::none;
}
void reattachToOperationContext(OperationContext* opCtx) final {
_opCtx = opCtx;
// _cursor recreated in restore() to avoid risk of WT_ROLLBACK issues.
}
protected:
// Called after _key has been filled in, ie a new key to be processed has been fetched.
// Must not throw WriteConflictException, throwing a WriteConflictException will retry the
// operation effectively skipping over this key.
virtual void updateIdAndTypeBits() {
if (_idx.rsKeyFormat() == KeyFormat::Long) {
_id = KeyString::decodeRecordIdLongAtEnd(_key.getBuffer(), _key.getSize());
} else {
invariant(_idx.rsKeyFormat() == KeyFormat::String);
_id = KeyString::decodeRecordIdStrAtEnd(_key.getBuffer(), _key.getSize());
}
WT_CURSOR* c = _cursor->get();
WT_ITEM item;
// Can't get WT_ROLLBACK and hence won't throw an exception.
// Don't expect WT_PREPARE_CONFLICT either.
auto ret = c->get_value(c, &item);
invariant(ret != WT_ROLLBACK && ret != WT_PREPARE_CONFLICT);
invariantWTOK(ret);
BufReader br(item.data, item.size);
_typeBits.resetFromBuffer(&br);
}
void setKey(WT_CURSOR* cursor, const WT_ITEM* item) {
cursor->set_key(cursor, item);
}
void getKey(WT_CURSOR* cursor, WT_ITEM* key) {
invariantWTOK(cursor->get_key(cursor, key));
auto& metricsCollector = ResourceConsumption::MetricsCollector::get(_opCtx);
metricsCollector.incrementOneIdxEntryRead(key->size);
}
boost::optional<IndexKeyEntry> curr(RequestedInfo parts) const {
if (_eof)
return {};
dassert(!atOrPastEndPointAfterSeeking());
dassert(!_id.isNull());
BSONObj bson;
if (TRACING_ENABLED || (parts & kWantKey)) {
bson =
KeyString::toBson(_key.getBuffer(), _key.getSize(), _idx.getOrdering(), _typeBits);
LOGV2_TRACE_CURSOR(20000, "returning {bson} {id}", "bson"_attr = bson, "id"_attr = _id);
}
return {{std::move(bson), _id}};
}
bool atOrPastEndPointAfterSeeking() const {
if (_eof)
return true;
if (!_endPosition)
return false;
const int cmp = _key.compare(*_endPosition);