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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
|
/**
* 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.
*/
#include "mongo/platform/basic.h"
#include "mongo/db/index/index_access_method.h"
#include <utility>
#include <vector>
#include "mongo/base/error_codes.h"
#include "mongo/base/status.h"
#include "mongo/db/catalog/index_catalog.h"
#include "mongo/db/catalog/index_consistency.h"
#include "mongo/db/client.h"
#include "mongo/db/commands/server_status.h"
#include "mongo/db/concurrency/exception_util.h"
#include "mongo/db/curop.h"
#include "mongo/db/index/2d_access_method.h"
#include "mongo/db/index/btree_access_method.h"
#include "mongo/db/index/bulk_builder_common.h"
#include "mongo/db/index/columns_access_method.h"
#include "mongo/db/index/fts_access_method.h"
#include "mongo/db/index/hash_access_method.h"
#include "mongo/db/index/index_build_interceptor.h"
#include "mongo/db/index/index_descriptor.h"
#include "mongo/db/index/s2_access_method.h"
#include "mongo/db/index/s2_bucket_access_method.h"
#include "mongo/db/index/wildcard_access_method.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/keypattern.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/repl/replication_coordinator.h"
#include "mongo/db/repl/timestamp_block.h"
#include "mongo/db/storage/execution_context.h"
#include "mongo/db/storage/kv/kv_engine.h"
#include "mongo/db/storage/storage_options.h"
#include "mongo/logv2/log.h"
#include "mongo/platform/atomic_word.h"
#include "mongo/util/progress_meter.h"
#include "mongo/util/scopeguard.h"
#include "mongo/util/stacktrace.h"
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kCommand
namespace mongo {
using std::pair;
using IndexVersion = IndexDescriptor::IndexVersion;
MONGO_FAIL_POINT_DEFINE(hangIndexBuildDuringBulkLoadPhase);
MONGO_FAIL_POINT_DEFINE(hangIndexBuildDuringBulkLoadPhaseSecond);
MONGO_FAIL_POINT_DEFINE(hangDuringIndexBuildBulkLoadYield);
MONGO_FAIL_POINT_DEFINE(hangDuringIndexBuildBulkLoadYieldSecond);
/**
* Static factory method that constructs and returns an appropriate IndexAccessMethod depending on
* the type of the index.
*/
std::unique_ptr<IndexAccessMethod> IndexAccessMethod::make(
OperationContext* opCtx,
const NamespaceString& nss,
const CollectionOptions& collectionOptions,
IndexCatalogEntry* entry,
StringData ident) {
auto engine = opCtx->getServiceContext()->getStorageEngine()->getEngine();
auto desc = entry->descriptor();
auto makeSDI = [&] {
return engine->getSortedDataInterface(opCtx, nss, collectionOptions, ident, desc);
};
auto makeCS = [&] {
return engine->getColumnStore(opCtx, nss, collectionOptions, ident, desc);
};
const std::string& type = desc->getAccessMethodName();
if ("" == type)
return std::make_unique<BtreeAccessMethod>(entry, makeSDI());
else if (IndexNames::HASHED == type)
return std::make_unique<HashAccessMethod>(entry, makeSDI());
else if (IndexNames::GEO_2DSPHERE == type)
return std::make_unique<S2AccessMethod>(entry, makeSDI());
else if (IndexNames::GEO_2DSPHERE_BUCKET == type)
return std::make_unique<S2BucketAccessMethod>(entry, makeSDI());
else if (IndexNames::TEXT == type)
return std::make_unique<FTSAccessMethod>(entry, makeSDI());
else if (IndexNames::GEO_2D == type)
return std::make_unique<TwoDAccessMethod>(entry, makeSDI());
else if (IndexNames::WILDCARD == type)
return std::make_unique<WildcardAccessMethod>(entry, makeSDI());
else if (IndexNames::COLUMN == type)
return std::make_unique<ColumnStoreAccessMethod>(entry, makeCS());
LOGV2(20688,
"Can't find index for keyPattern {keyPattern}",
"Can't find index for keyPattern",
"keyPattern"_attr = desc->keyPattern());
fassertFailed(31021);
}
namespace {
/**
* Metrics for index bulk builder operations. Intended to support index build diagnostics
* during the following scenarios:
* - createIndex commands;
* - collection cloning during initial sync; and
* - resuming index builds at startup.
*
* Also includes statistics for disk usage (by the external sorter) for index builds that
* do not fit in memory.
*/
class IndexBulkBuilderSSS : public ServerStatusSection {
public:
IndexBulkBuilderSSS() : ServerStatusSection("indexBulkBuilder") {}
bool includeByDefault() const final {
return true;
}
BSONObj generateSection(OperationContext* opCtx, const BSONElement& configElement) const final {
BSONObjBuilder builder;
builder.append("count", count.loadRelaxed());
builder.append("resumed", resumed.loadRelaxed());
builder.append("filesOpenedForExternalSort", sorterFileStats.opened.loadRelaxed());
builder.append("filesClosedForExternalSort", sorterFileStats.closed.loadRelaxed());
builder.append("spilledRanges", sorterTracker.spilledRanges.loadRelaxed());
builder.append("bytesSpilledUncompressed",
sorterTracker.bytesSpilledUncompressed.loadRelaxed());
builder.append("bytesSpilled", sorterTracker.bytesSpilled.loadRelaxed());
builder.append("numSorted", sorterTracker.numSorted.loadRelaxed());
builder.append("bytesSorted", sorterTracker.bytesSorted.loadRelaxed());
builder.append("memUsage", sorterTracker.memUsage.loadRelaxed());
return builder.obj();
}
// Number of instances of the bulk builder created.
AtomicWord<long long> count;
// Number of times the bulk builder was created for a resumable index build.
// This value should not exceed 'count'.
AtomicWord<long long> resumed;
// Sorter statistics that are aggregate of all sorters.
SorterTracker sorterTracker;
// Number of times the external sorter opened/closed a file handle to spill data to disk.
// This pair of counters in aggregate indicate the number of open file handles used by
// the external sorter and may be useful in diagnosing situations where the process is
// close to exhausting this finite resource.
SorterFileStats sorterFileStats = {&sorterTracker};
} indexBulkBuilderSSS;
/**
* Returns true if at least one prefix of any of the indexed fields causes the index to be
* multikey, and returns false otherwise. This function returns false if the 'multikeyPaths'
* vector is empty.
*/
bool isMultikeyFromPaths(const MultikeyPaths& multikeyPaths) {
return std::any_of(multikeyPaths.cbegin(),
multikeyPaths.cend(),
[](const MultikeyComponents& components) { return !components.empty(); });
}
SortOptions makeSortOptions(size_t maxMemoryUsageBytes, StringData dbName, SorterFileStats* stats) {
return SortOptions()
.TempDir(storageGlobalParams.dbpath + "/_tmp")
.ExtSortAllowed()
.MaxMemoryUsageBytes(maxMemoryUsageBytes)
.UseMemoryPool(true)
.FileStats(stats)
.Tracker(&indexBulkBuilderSSS.sorterTracker)
.DBName(dbName.toString());
}
MultikeyPaths createMultikeyPaths(const std::vector<MultikeyPath>& multikeyPathsVec) {
MultikeyPaths multikeyPaths;
for (const auto& multikeyPath : multikeyPathsVec) {
multikeyPaths.emplace_back(boost::container::ordered_unique_range_t(),
multikeyPath.getMultikeyComponents().begin(),
multikeyPath.getMultikeyComponents().end());
}
return multikeyPaths;
}
} // namespace
struct BtreeExternalSortComparison {
int operator()(const KeyString::Value& l, const KeyString::Value& r) const {
return l.compare(r);
}
};
SortedDataIndexAccessMethod::SortedDataIndexAccessMethod(const IndexCatalogEntry* btreeState,
std::unique_ptr<SortedDataInterface> btree)
: _indexCatalogEntry(btreeState),
_descriptor(btreeState->descriptor()),
_newInterface(std::move(btree)) {
verify(IndexDescriptor::isIndexVersionSupported(_descriptor->version()));
}
Status SortedDataIndexAccessMethod::insert(OperationContext* opCtx,
SharedBufferFragmentBuilder& pooledBuilder,
const CollectionPtr& coll,
const std::vector<BsonRecord>& bsonRecords,
const InsertDeleteOptions& options,
int64_t* numInserted) {
for (const auto& bsonRecord : bsonRecords) {
invariant(bsonRecord.id != RecordId());
if (!bsonRecord.ts.isNull()) {
Status status = opCtx->recoveryUnit()->setTimestamp(bsonRecord.ts);
if (!status.isOK())
return status;
}
auto& executionCtx = StorageExecutionContext::get(opCtx);
auto keys = executionCtx.keys();
auto multikeyMetadataKeys = executionCtx.multikeyMetadataKeys();
auto multikeyPaths = executionCtx.multikeyPaths();
getKeys(opCtx,
coll,
pooledBuilder,
*bsonRecord.docPtr,
options.getKeysMode,
GetKeysContext::kAddingKeys,
keys.get(),
multikeyMetadataKeys.get(),
multikeyPaths.get(),
bsonRecord.id);
Status status = _indexKeysOrWriteToSideTable(opCtx,
coll,
*keys,
*multikeyMetadataKeys,
*multikeyPaths,
*bsonRecord.docPtr,
options,
numInserted);
if (!status.isOK()) {
return status;
}
}
return Status::OK();
}
void SortedDataIndexAccessMethod::remove(OperationContext* opCtx,
SharedBufferFragmentBuilder& pooledBuilder,
const CollectionPtr& coll,
const BSONObj& obj,
const RecordId& loc,
bool logIfError,
const InsertDeleteOptions& options,
int64_t* numDeleted,
CheckRecordId checkRecordId) {
auto& executionCtx = StorageExecutionContext::get(opCtx);
// There's no need to compute the prefixes of the indexed fields that cause the index to be
// multikey when removing a document since the index metadata isn't updated when keys are
// deleted.
auto keys = executionCtx.keys();
getKeys(opCtx,
coll,
pooledBuilder,
obj,
InsertDeleteOptions::ConstraintEnforcementMode::kRelaxConstraintsUnfiltered,
GetKeysContext::kRemovingKeys,
keys.get(),
nullptr,
nullptr,
loc);
_unindexKeysOrWriteToSideTable(
opCtx, coll->ns(), *keys, obj, logIfError, numDeleted, options, checkRecordId);
}
Status SortedDataIndexAccessMethod::update(OperationContext* opCtx,
SharedBufferFragmentBuilder& pooledBufferBuilder,
const BSONObj& oldDoc,
const BSONObj& newDoc,
const RecordId& loc,
const CollectionPtr& coll,
const InsertDeleteOptions& options,
int64_t* numInserted,
int64_t* numDeleted) {
UpdateTicket updateTicket;
prepareUpdate(opCtx, coll, oldDoc, newDoc, loc, options, &updateTicket);
auto status = Status::OK();
if (_indexCatalogEntry->isHybridBuilding() || !_indexCatalogEntry->isReady(opCtx)) {
bool logIfError = false;
_unindexKeysOrWriteToSideTable(opCtx,
coll->ns(),
updateTicket.removed,
oldDoc,
logIfError,
numDeleted,
options,
CheckRecordId::Off);
return _indexKeysOrWriteToSideTable(opCtx,
coll,
updateTicket.added,
updateTicket.newMultikeyMetadataKeys,
updateTicket.newMultikeyPaths,
newDoc,
options,
numInserted);
} else {
return doUpdate(opCtx, coll, updateTicket, numInserted, numDeleted);
}
}
Status SortedDataIndexAccessMethod::insertKeysAndUpdateMultikeyPaths(
OperationContext* opCtx,
const CollectionPtr& coll,
const KeyStringSet& keys,
const KeyStringSet& multikeyMetadataKeys,
const MultikeyPaths& multikeyPaths,
const InsertDeleteOptions& options,
KeyHandlerFn&& onDuplicateKey,
int64_t* numInserted,
IncludeDuplicateRecordId includeDuplicateRecordId) {
// Insert the specified data keys into the index.
auto status = insertKeys(opCtx,
coll,
keys,
options,
std::move(onDuplicateKey),
numInserted,
includeDuplicateRecordId);
if (!status.isOK()) {
return status;
}
// If these keys should cause the index to become multikey, pass them into the catalog.
if (shouldMarkIndexAsMultikey(keys.size(), multikeyMetadataKeys, multikeyPaths)) {
_indexCatalogEntry->setMultikey(opCtx, coll, multikeyMetadataKeys, multikeyPaths);
}
// If we have some multikey metadata keys, they should have been added while marking the index
// as multikey in the catalog. Add them to the count of keys inserted for completeness.
if (numInserted && !multikeyMetadataKeys.empty()) {
*numInserted += multikeyMetadataKeys.size();
}
return Status::OK();
}
Status SortedDataIndexAccessMethod::insertKeys(OperationContext* opCtx,
const CollectionPtr& coll,
const KeyStringSet& keys,
const InsertDeleteOptions& options,
KeyHandlerFn&& onDuplicateKey,
int64_t* numInserted,
IncludeDuplicateRecordId includeDuplicateRecordId) {
// Initialize the 'numInserted' out-parameter to zero in case the caller did not already do so.
if (numInserted) {
*numInserted = 0;
}
bool unique = _descriptor->unique();
bool prepareUnique = _descriptor->prepareUnique();
bool dupsAllowed;
if (!_descriptor->isIdIndex() && !opCtx->isEnforcingConstraints() &&
coll->isIndexReady(_descriptor->indexName())) {
// Oplog application should avoid checking for duplicates on unique indexes except when:
// 1. Building an index. We have to use the duplicate key error to record possible
// conflicts.
// 2. Inserting into the '_id' index. We never allow duplicates in the '_id' index.
//
// Additionally, unique indexes conflict checking can cause out-of-order updates in
// wiredtiger. See SERVER-59831.
dupsAllowed = true;
} else if (prepareUnique) {
// Before the index build commits, duplicate keys are allowed to exist with the
// 'prepareUnique' option. After that, duplicates are not allowed.
dupsAllowed = !coll->isIndexReady(_descriptor->indexName());
} else {
dupsAllowed = !unique;
}
// Add all new keys into the index. The RecordId for each is already encoded in the KeyString.
for (const auto& keyString : keys) {
auto status =
_newInterface->insert(opCtx, keyString, dupsAllowed, includeDuplicateRecordId);
// When duplicates are encountered and allowed, retry with dupsAllowed. Call
// onDuplicateKey() with the inserted duplicate key.
if (ErrorCodes::DuplicateKey == status.code() && options.dupsAllowed && !prepareUnique) {
invariant(unique);
status = _newInterface->insert(
opCtx, keyString, true /* dupsAllowed */, includeDuplicateRecordId);
if (status.isOK() && onDuplicateKey) {
status = onDuplicateKey(keyString);
}
}
if (!status.isOK()) {
return status;
}
}
if (numInserted) {
*numInserted = keys.size();
}
return Status::OK();
}
void SortedDataIndexAccessMethod::removeOneKey(OperationContext* opCtx,
const KeyString::Value& keyString,
bool dupsAllowed) {
try {
_newInterface->unindex(opCtx, keyString, dupsAllowed);
} catch (AssertionException& e) {
NamespaceString ns = _indexCatalogEntry->getNSSFromCatalog(opCtx);
LOGV2(20683,
"Assertion failure: _unindex failed on: {namespace} for index: {indexName}. "
"{error} KeyString:{keyString}",
"Assertion failure: _unindex failed",
"error"_attr = redact(e),
"keyString"_attr = keyString,
"namespace"_attr = ns,
"indexName"_attr = _descriptor->indexName());
printStackTrace();
}
}
std::unique_ptr<SortedDataInterface::Cursor> SortedDataIndexAccessMethod::newCursor(
OperationContext* opCtx, bool isForward) const {
return _newInterface->newCursor(opCtx, isForward);
}
Status SortedDataIndexAccessMethod::removeKeys(OperationContext* opCtx,
const KeyStringSet& keys,
const InsertDeleteOptions& options,
int64_t* numDeleted) {
for (const auto& key : keys) {
removeOneKey(opCtx, key, options.dupsAllowed);
}
*numDeleted = keys.size();
return Status::OK();
}
Status SortedDataIndexAccessMethod::initializeAsEmpty(OperationContext* opCtx) {
return _newInterface->initAsEmpty(opCtx);
}
RecordId SortedDataIndexAccessMethod::findSingle(OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& requestedKey) const {
// Generate the key for this index.
KeyString::Value actualKey = [&]() {
if (_indexCatalogEntry->getCollator()) {
// For performance, call get keys only if there is a non-simple collation.
SharedBufferFragmentBuilder pooledBuilder(
KeyString::HeapBuilder::kHeapAllocatorDefaultBytes);
auto& executionCtx = StorageExecutionContext::get(opCtx);
auto keys = executionCtx.keys();
KeyStringSet* multikeyMetadataKeys = nullptr;
MultikeyPaths* multikeyPaths = nullptr;
getKeys(opCtx,
collection,
pooledBuilder,
requestedKey,
InsertDeleteOptions::ConstraintEnforcementMode::kEnforceConstraints,
GetKeysContext::kAddingKeys,
keys.get(),
multikeyMetadataKeys,
multikeyPaths,
boost::none /* loc */);
invariant(keys->size() == 1);
return *keys->begin();
} else {
KeyString::HeapBuilder requestedKeyString(
getSortedDataInterface()->getKeyStringVersion(),
BSONObj::stripFieldNames(requestedKey),
getSortedDataInterface()->getOrdering());
return requestedKeyString.release();
}
}();
if (auto loc = _newInterface->findLoc(opCtx, actualKey)) {
dassert(!loc->isNull());
return std::move(*loc);
}
return RecordId();
}
IndexValidateResults SortedDataIndexAccessMethod::validate(OperationContext* opCtx,
bool full) const {
return _newInterface->validate(opCtx, full);
}
int64_t SortedDataIndexAccessMethod::numKeys(OperationContext* opCtx) const {
return _newInterface->numEntries(opCtx);
}
bool SortedDataIndexAccessMethod::appendCustomStats(OperationContext* opCtx,
BSONObjBuilder* output,
double scale) const {
return _newInterface->appendCustomStats(opCtx, output, scale);
}
long long SortedDataIndexAccessMethod::getSpaceUsedBytes(OperationContext* opCtx) const {
return _newInterface->getSpaceUsedBytes(opCtx);
}
long long SortedDataIndexAccessMethod::getFreeStorageBytes(OperationContext* opCtx) const {
return _newInterface->getFreeStorageBytes(opCtx);
}
pair<KeyStringSet, KeyStringSet> SortedDataIndexAccessMethod::setDifference(
const KeyStringSet& left, const KeyStringSet& right) {
// Two iterators to traverse the two sets in sorted order.
auto leftIt = left.begin();
auto rightIt = right.begin();
KeyStringSet::sequence_type onlyLeft;
KeyStringSet::sequence_type onlyRight;
while (leftIt != left.end() && rightIt != right.end()) {
// Use compareWithTypeBits instead of the regular compare as we want just a difference in
// typeinfo to also result in an index change.
const int cmp = leftIt->compareWithTypeBits(*rightIt);
if (cmp == 0) {
++leftIt;
++rightIt;
} else if (cmp > 0) {
onlyRight.push_back(*rightIt);
++rightIt;
} else {
onlyLeft.push_back(*leftIt);
++leftIt;
}
}
// Add the rest of 'left' to 'onlyLeft', and the rest of 'right' to 'onlyRight', if any.
onlyLeft.insert(onlyLeft.end(), leftIt, left.end());
onlyRight.insert(onlyRight.end(), rightIt, right.end());
KeyStringSet outLeft;
KeyStringSet outRight;
// The above algorithm guarantees that the elements are sorted and unique, so we can let the
// container know so we get O(1) complexity adopting it.
outLeft.adopt_sequence(boost::container::ordered_unique_range_t(), std::move(onlyLeft));
outRight.adopt_sequence(boost::container::ordered_unique_range_t(), std::move(onlyRight));
return {{std::move(outLeft)}, {std::move(outRight)}};
}
void SortedDataIndexAccessMethod::prepareUpdate(OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& from,
const BSONObj& to,
const RecordId& record,
const InsertDeleteOptions& options,
UpdateTicket* ticket) const {
SharedBufferFragmentBuilder pooledBuilder(KeyString::HeapBuilder::kHeapAllocatorDefaultBytes);
const MatchExpression* indexFilter = _indexCatalogEntry->getFilterExpression();
if (!indexFilter || indexFilter->matchesBSON(from)) {
// Override key constraints when generating keys for removal. This only applies to keys
// that do not apply to a partial filter expression.
const auto getKeysMode = _indexCatalogEntry->isHybridBuilding()
? InsertDeleteOptions::ConstraintEnforcementMode::kRelaxConstraintsUnfiltered
: options.getKeysMode;
// There's no need to compute the prefixes of the indexed fields that possibly caused the
// index to be multikey when the old version of the document was written since the index
// metadata isn't updated when keys are deleted.
getKeys(opCtx,
collection,
pooledBuilder,
from,
getKeysMode,
GetKeysContext::kRemovingKeys,
&ticket->oldKeys,
nullptr,
nullptr,
record);
}
if (!indexFilter || indexFilter->matchesBSON(to)) {
getKeys(opCtx,
collection,
pooledBuilder,
to,
options.getKeysMode,
GetKeysContext::kAddingKeys,
&ticket->newKeys,
&ticket->newMultikeyMetadataKeys,
&ticket->newMultikeyPaths,
record);
}
ticket->loc = record;
ticket->dupsAllowed = options.dupsAllowed;
std::tie(ticket->removed, ticket->added) = setDifference(ticket->oldKeys, ticket->newKeys);
ticket->_isValid = true;
}
Status SortedDataIndexAccessMethod::doUpdate(OperationContext* opCtx,
const CollectionPtr& coll,
const UpdateTicket& ticket,
int64_t* numInserted,
int64_t* numDeleted) {
invariant(!_indexCatalogEntry->isHybridBuilding());
invariant(ticket.newKeys.size() ==
ticket.oldKeys.size() + ticket.added.size() - ticket.removed.size());
invariant(numInserted);
invariant(numDeleted);
*numInserted = 0;
*numDeleted = 0;
if (!ticket._isValid) {
return Status(ErrorCodes::InternalError, "Invalid UpdateTicket in update");
}
for (const auto& remKey : ticket.removed) {
_newInterface->unindex(opCtx, remKey, ticket.dupsAllowed);
}
// Add all new data keys into the index.
for (const auto& keyString : ticket.added) {
bool dupsAllowed = !_descriptor->prepareUnique() && ticket.dupsAllowed;
auto status = _newInterface->insert(opCtx, keyString, dupsAllowed);
if (!status.isOK())
return status;
}
// If these keys should cause the index to become multikey, pass them into the catalog.
if (shouldMarkIndexAsMultikey(
ticket.newKeys.size(), ticket.newMultikeyMetadataKeys, ticket.newMultikeyPaths)) {
_indexCatalogEntry->setMultikey(
opCtx, coll, ticket.newMultikeyMetadataKeys, ticket.newMultikeyPaths);
}
// If we have some multikey metadata keys, they should have been added while marking the index
// as multikey in the catalog. Add them to the count of keys inserted for completeness.
*numInserted = ticket.added.size() + ticket.newMultikeyMetadataKeys.size();
*numDeleted = ticket.removed.size();
return Status::OK();
}
Status SortedDataIndexAccessMethod::compact(OperationContext* opCtx) {
return this->_newInterface->compact(opCtx);
}
std::shared_ptr<Ident> SortedDataIndexAccessMethod::getSharedIdent() const {
return this->_newInterface->getSharedIdent();
}
void SortedDataIndexAccessMethod::setIdent(std::shared_ptr<Ident> newIdent) {
this->_newInterface->setIdent(std::move(newIdent));
}
Status SortedDataIndexAccessMethod::applyIndexBuildSideWrite(OperationContext* opCtx,
const CollectionPtr& coll,
const BSONObj& operation,
const InsertDeleteOptions& options,
KeyHandlerFn&& onDuplicateKey,
int64_t* const keysInserted,
int64_t* const keysDeleted) {
auto opType = [&operation] {
switch (operation.getStringField("op")[0]) {
case 'i':
return IndexBuildInterceptor::Op::kInsert;
case 'd':
return IndexBuildInterceptor::Op::kDelete;
case 'u':
return IndexBuildInterceptor::Op::kUpdate;
default:
MONGO_UNREACHABLE;
}
}();
// Deserialize the encoded KeyString::Value.
int keyLen;
const char* binKey = operation["key"].binData(keyLen);
BufReader reader(binKey, keyLen);
const KeyString::Value keyString =
KeyString::Value::deserialize(reader, getSortedDataInterface()->getKeyStringVersion());
const KeyStringSet keySet{keyString};
if (opType == IndexBuildInterceptor::Op::kInsert) {
int64_t numInserted;
auto status = insertKeysAndUpdateMultikeyPaths(opCtx,
coll,
{keySet.begin(), keySet.end()},
{},
MultikeyPaths{},
options,
std::move(onDuplicateKey),
&numInserted);
if (!status.isOK()) {
return status;
}
*keysInserted += numInserted;
opCtx->recoveryUnit()->onRollback(
[keysInserted, numInserted] { *keysInserted -= numInserted; });
} else {
invariant(opType == IndexBuildInterceptor::Op::kDelete);
int64_t numDeleted;
Status s = removeKeys(opCtx, {keySet.begin(), keySet.end()}, options, &numDeleted);
if (!s.isOK()) {
return s;
}
*keysDeleted += numDeleted;
opCtx->recoveryUnit()->onRollback(
[keysDeleted, numDeleted] { *keysDeleted -= numDeleted; });
}
return Status::OK();
}
void IndexAccessMethod::BulkBuilder::countNewBuildInStats() {
indexBulkBuilderSSS.count.addAndFetch(1);
}
void IndexAccessMethod::BulkBuilder::countResumedBuildInStats() {
indexBulkBuilderSSS.count.addAndFetch(1);
indexBulkBuilderSSS.resumed.addAndFetch(1);
}
SorterFileStats* IndexAccessMethod::BulkBuilder::bulkBuilderFileStats() {
return &indexBulkBuilderSSS.sorterFileStats;
}
SorterTracker* IndexAccessMethod::BulkBuilder::bulkBuilderTracker() {
return &indexBulkBuilderSSS.sorterTracker;
}
void IndexAccessMethod::BulkBuilder::yield(OperationContext* opCtx,
const Yieldable* yieldable,
const NamespaceString& ns) {
// Releasing locks means a new snapshot should be acquired when restored.
opCtx->recoveryUnit()->abandonSnapshot();
yieldable->yield();
auto locker = opCtx->lockState();
Locker::LockSnapshot snapshot;
if (locker->saveLockStateAndUnlock(&snapshot)) {
// Track the number of yields in CurOp.
CurOp::get(opCtx)->yielded();
auto failPointHang = [opCtx, &ns](FailPoint* fp) {
fp->executeIf(
[fp](auto&&) {
LOGV2(5180600, "Hanging index build during bulk load yield");
fp->pauseWhileSet();
},
[opCtx, &ns](auto&& config) {
return config.getStringField("namespace") == ns.ns();
});
};
failPointHang(&hangDuringIndexBuildBulkLoadYield);
failPointHang(&hangDuringIndexBuildBulkLoadYieldSecond);
locker->restoreLockState(opCtx, snapshot);
}
yieldable->restore();
}
class SortedDataIndexAccessMethod::BulkBuilderImpl final
: public BulkBuilderCommon<SortedDataIndexAccessMethod::BulkBuilderImpl> {
public:
using Sorter = mongo::Sorter<KeyString::Value, mongo::NullValue>;
BulkBuilderImpl(SortedDataIndexAccessMethod* iam,
size_t maxMemoryUsageBytes,
StringData dbName);
BulkBuilderImpl(SortedDataIndexAccessMethod* iam,
size_t maxMemoryUsageBytes,
const IndexStateInfo& stateInfo,
StringData dbName);
Status insert(OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& obj,
const RecordId& loc,
const InsertDeleteOptions& options,
const std::function<void()>& saveCursorBeforeWrite,
const std::function<void()>& restoreCursorAfterWrite) final;
const MultikeyPaths& getMultikeyPaths() const final;
bool isMultikey() const final;
IndexStateInfo persistDataForShutdown() final;
std::unique_ptr<Sorter::Iterator> finalizeSort();
std::unique_ptr<SortedDataBuilderInterface> setUpBulkInserter(OperationContext* opCtx,
bool dupsAllowed);
void debugEnsureSorted(const Sorter::Data& data);
bool duplicateCheck(OperationContext* opCtx,
const Sorter::Data& data,
bool dupsAllowed,
const RecordIdHandlerFn& onDuplicateRecord);
void insertKey(std::unique_ptr<SortedDataBuilderInterface>& inserter, const Sorter::Data& data);
Status keyCommitted(const KeyHandlerFn& onDuplicateKeyInserted,
const Sorter::Data& data,
bool isDup);
private:
void _insertMultikeyMetadataKeysIntoSorter();
Sorter* _makeSorter(
size_t maxMemoryUsageBytes,
StringData dbName,
boost::optional<StringData> fileName = boost::none,
const boost::optional<std::vector<SorterRange>>& ranges = boost::none) const;
Sorter::Settings _makeSorterSettings() const;
SortedDataIndexAccessMethod* _iam;
std::unique_ptr<Sorter> _sorter;
KeyString::Value _previousKey;
// Set to true if any document added to the BulkBuilder causes the index to become multikey.
bool _isMultiKey = false;
// Holds the path components that cause this index to be multikey. The '_indexMultikeyPaths'
// vector remains empty if this index doesn't support path-level multikey tracking.
MultikeyPaths _indexMultikeyPaths;
// Caches the set of all multikey metadata keys generated during the bulk build process.
// These are inserted into the sorter after all normal data keys have been added, just
// before the bulk build is committed.
KeyStringSet _multikeyMetadataKeys;
};
std::unique_ptr<IndexAccessMethod::BulkBuilder> SortedDataIndexAccessMethod::initiateBulk(
size_t maxMemoryUsageBytes,
const boost::optional<IndexStateInfo>& stateInfo,
StringData dbName) {
return stateInfo
? std::make_unique<BulkBuilderImpl>(this, maxMemoryUsageBytes, *stateInfo, dbName)
: std::make_unique<BulkBuilderImpl>(this, maxMemoryUsageBytes, dbName);
}
SortedDataIndexAccessMethod::BulkBuilderImpl::BulkBuilderImpl(SortedDataIndexAccessMethod* iam,
size_t maxMemoryUsageBytes,
StringData dbName)
: BulkBuilderCommon(0,
"Index Build: inserting keys from external sorter into index",
iam->_descriptor->indexName()),
_iam(iam),
_sorter(_makeSorter(maxMemoryUsageBytes, dbName)) {
countNewBuildInStats();
}
SortedDataIndexAccessMethod::BulkBuilderImpl::BulkBuilderImpl(SortedDataIndexAccessMethod* iam,
size_t maxMemoryUsageBytes,
const IndexStateInfo& stateInfo,
StringData dbName)
: BulkBuilderCommon(stateInfo.getNumKeys().value_or(0),
"Index Build: inserting keys from external sorter into index",
iam->_descriptor->indexName()),
_iam(iam),
_sorter(
_makeSorter(maxMemoryUsageBytes, dbName, stateInfo.getFileName(), stateInfo.getRanges())),
_isMultiKey(stateInfo.getIsMultikey()),
_indexMultikeyPaths(createMultikeyPaths(stateInfo.getMultikeyPaths())) {
countResumedBuildInStats();
}
Status SortedDataIndexAccessMethod::BulkBuilderImpl::insert(
OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& obj,
const RecordId& loc,
const InsertDeleteOptions& options,
const std::function<void()>& saveCursorBeforeWrite,
const std::function<void()>& restoreCursorAfterWrite) {
auto& executionCtx = StorageExecutionContext::get(opCtx);
auto keys = executionCtx.keys();
auto multikeyPaths = executionCtx.multikeyPaths();
try {
_iam->getKeys(opCtx,
collection,
_sorter->memPool(),
obj,
options.getKeysMode,
GetKeysContext::kAddingKeys,
keys.get(),
&_multikeyMetadataKeys,
multikeyPaths.get(),
loc,
[&](Status status, const BSONObj&, const boost::optional<RecordId>&) {
// If a key generation error was suppressed, record the document as
// "skipped" so the index builder can retry at a point when data is
// consistent.
auto interceptor = _iam->_indexCatalogEntry->indexBuildInterceptor();
if (interceptor && interceptor->getSkippedRecordTracker()) {
LOGV2_DEBUG(
20684,
1,
"Recording suppressed key generation error to retry later: "
"{error} on {loc}: {obj}",
"error"_attr = status,
"loc"_attr = loc,
"obj"_attr = redact(obj));
// Save and restore the cursor around the write in case it throws a
// WCE internally and causes the cursor to be unpositioned.
saveCursorBeforeWrite();
interceptor->getSkippedRecordTracker()->record(opCtx, loc);
restoreCursorAfterWrite();
}
});
} catch (...) {
return exceptionToStatus();
}
if (!multikeyPaths->empty()) {
if (_indexMultikeyPaths.empty()) {
_indexMultikeyPaths = *multikeyPaths;
} else {
invariant(_indexMultikeyPaths.size() == multikeyPaths->size());
for (size_t i = 0; i < multikeyPaths->size(); ++i) {
_indexMultikeyPaths[i].insert(boost::container::ordered_unique_range_t(),
(*multikeyPaths)[i].begin(),
(*multikeyPaths)[i].end());
}
}
}
for (const auto& keyString : *keys) {
_sorter->add(keyString, mongo::NullValue());
++_keysInserted;
}
_isMultiKey = _isMultiKey ||
_iam->shouldMarkIndexAsMultikey(keys->size(), _multikeyMetadataKeys, *multikeyPaths);
return Status::OK();
}
const MultikeyPaths& SortedDataIndexAccessMethod::BulkBuilderImpl::getMultikeyPaths() const {
return _indexMultikeyPaths;
}
bool SortedDataIndexAccessMethod::BulkBuilderImpl::isMultikey() const {
return _isMultiKey;
}
IndexStateInfo SortedDataIndexAccessMethod::BulkBuilderImpl::persistDataForShutdown() {
_insertMultikeyMetadataKeysIntoSorter();
auto state = _sorter->persistDataForShutdown();
IndexStateInfo stateInfo;
stateInfo.setFileName(StringData(state.fileName));
stateInfo.setNumKeys(_keysInserted);
stateInfo.setRanges(std::move(state.ranges));
return stateInfo;
}
void SortedDataIndexAccessMethod::BulkBuilderImpl::_insertMultikeyMetadataKeysIntoSorter() {
for (const auto& keyString : _multikeyMetadataKeys) {
_sorter->add(keyString, mongo::NullValue());
++_keysInserted;
}
// We clear the multikey metadata keys to prevent them from being inserted into the Sorter
// twice in the case that done() is called and then persistDataForShutdown() is later called.
_multikeyMetadataKeys.clear();
}
SortedDataIndexAccessMethod::BulkBuilderImpl::Sorter::Settings
SortedDataIndexAccessMethod::BulkBuilderImpl::_makeSorterSettings() const {
return std::pair<KeyString::Value::SorterDeserializeSettings,
mongo::NullValue::SorterDeserializeSettings>(
{_iam->getSortedDataInterface()->getKeyStringVersion()}, {});
}
SortedDataIndexAccessMethod::BulkBuilderImpl::Sorter*
SortedDataIndexAccessMethod::BulkBuilderImpl::_makeSorter(
size_t maxMemoryUsageBytes,
StringData dbName,
boost::optional<StringData> fileName,
const boost::optional<std::vector<SorterRange>>& ranges) const {
return fileName
? Sorter::makeFromExistingRanges(
fileName->toString(),
*ranges,
makeSortOptions(maxMemoryUsageBytes, dbName, bulkBuilderFileStats()),
BtreeExternalSortComparison(),
_makeSorterSettings())
: Sorter::make(makeSortOptions(maxMemoryUsageBytes, dbName, bulkBuilderFileStats()),
BtreeExternalSortComparison(),
_makeSorterSettings());
}
std::unique_ptr<mongo::Sorter<KeyString::Value, mongo::NullValue>::Iterator>
SortedDataIndexAccessMethod::BulkBuilderImpl::finalizeSort() {
_insertMultikeyMetadataKeysIntoSorter();
return std::unique_ptr<Sorter::Iterator>(_sorter->done());
}
std::unique_ptr<SortedDataBuilderInterface>
SortedDataIndexAccessMethod::BulkBuilderImpl::setUpBulkInserter(OperationContext* opCtx,
bool dupsAllowed) {
_ns = _iam->_indexCatalogEntry->getNSSFromCatalog(opCtx);
return _iam->getSortedDataInterface()->makeBulkBuilder(opCtx, dupsAllowed);
}
void SortedDataIndexAccessMethod::BulkBuilderImpl::debugEnsureSorted(const Sorter::Data& data) {
if (data.first.compare(_previousKey) < 0) {
LOGV2_FATAL_NOTRACE(31171,
"Expected the next key to be greater than or equal to the previous key",
"nextKey"_attr = data.first.toString(),
"previousKey"_attr = _previousKey.toString(),
"index"_attr = _indexName);
}
}
bool SortedDataIndexAccessMethod::BulkBuilderImpl::duplicateCheck(
OperationContext* opCtx,
const Sorter::Data& data,
bool dupsAllowed,
const RecordIdHandlerFn& onDuplicateRecord) {
auto descriptor = _iam->_descriptor;
bool isDup = false;
if (descriptor->unique()) {
int cmpData = (_iam->getSortedDataInterface()->rsKeyFormat() == KeyFormat::Long)
? data.first.compareWithoutRecordIdLong(_previousKey)
: data.first.compareWithoutRecordIdStr(_previousKey);
isDup = (cmpData == 0);
}
// Before attempting to insert, perform a duplicate key check.
if (isDup && !dupsAllowed) {
uassertStatusOK(_iam->_handleDuplicateKey(opCtx, data.first, onDuplicateRecord));
}
return isDup;
}
void SortedDataIndexAccessMethod::BulkBuilderImpl::insertKey(
std::unique_ptr<SortedDataBuilderInterface>& inserter, const Sorter::Data& data) {
uassertStatusOK(inserter->addKey(data.first));
}
Status SortedDataIndexAccessMethod::BulkBuilderImpl::keyCommitted(
const KeyHandlerFn& onDuplicateKeyInserted, const Sorter::Data& data, bool isDup) {
_previousKey = data.first;
if (isDup) {
return onDuplicateKeyInserted(data.first);
}
return Status::OK();
}
void SortedDataIndexAccessMethod::getKeys(OperationContext* opCtx,
const CollectionPtr& collection,
SharedBufferFragmentBuilder& pooledBufferBuilder,
const BSONObj& obj,
InsertDeleteOptions::ConstraintEnforcementMode mode,
GetKeysContext context,
KeyStringSet* keys,
KeyStringSet* multikeyMetadataKeys,
MultikeyPaths* multikeyPaths,
const boost::optional<RecordId>& id,
OnSuppressedErrorFn&& onSuppressedError) const {
invariant(!id || _newInterface->rsKeyFormat() != KeyFormat::String || id->isStr(),
fmt::format("RecordId is not in the same string format as its RecordStore; id: {}",
id->toString()));
invariant(!id || _newInterface->rsKeyFormat() != KeyFormat::Long || id->isLong(),
fmt::format("RecordId is not in the same long format as its RecordStore; id: {}",
id->toString()));
try {
if (_indexCatalogEntry->shouldValidateDocument()) {
validateDocument(collection, obj, _descriptor->keyPattern());
}
doGetKeys(opCtx,
collection,
pooledBufferBuilder,
obj,
context,
keys,
multikeyMetadataKeys,
multikeyPaths,
id);
} catch (const AssertionException& ex) {
// Suppress all indexing errors when mode is kRelaxConstraints.
if (mode == InsertDeleteOptions::ConstraintEnforcementMode::kEnforceConstraints) {
throw;
}
keys->clear();
if (multikeyPaths) {
multikeyPaths->clear();
}
if (!opCtx->checkForInterruptNoAssert().isOK()) {
throw;
}
// If the document applies to the filter (which means that it should have never been
// indexed), do not suppress the error.
const MatchExpression* filter = _indexCatalogEntry->getFilterExpression();
if (mode == InsertDeleteOptions::ConstraintEnforcementMode::kRelaxConstraintsUnfiltered &&
filter && filter->matchesBSON(obj)) {
throw;
}
if (onSuppressedError) {
onSuppressedError(ex.toStatus(), obj, id);
} else {
LOGV2_DEBUG(20686,
1,
"Suppressed key generation error",
"error"_attr = redact(ex.toStatus()),
"loc"_attr = id,
"obj"_attr = redact(obj));
}
}
}
bool SortedDataIndexAccessMethod::shouldMarkIndexAsMultikey(
size_t numberOfKeys,
const KeyStringSet& multikeyMetadataKeys,
const MultikeyPaths& multikeyPaths) const {
return numberOfKeys > 1 || isMultikeyFromPaths(multikeyPaths);
}
void SortedDataIndexAccessMethod::validateDocument(const CollectionPtr& collection,
const BSONObj& obj,
const BSONObj& keyPattern) const {}
/**
* Generates a new file name on each call using a static, atomic and monotonically increasing
* number. Each name is suffixed with a random number generated at startup, to prevent name
* collisions when the index build external sort files are preserved across restarts.
*
* Each user of the Sorter must implement this function to ensure that all temporary files that the
* Sorter instances produce are uniquely identified using a unique file name extension with separate
* atomic variable. This is necessary because the sorter.cpp code is separately included in multiple
* places, rather than compiled in one place and linked, and so cannot provide a globally unique ID.
*/
std::string nextFileName() {
static AtomicWord<unsigned> indexAccessMethodFileCounter;
static const int64_t randomSuffix = SecureRandom().nextInt64();
return str::stream() << "extsort-index." << indexAccessMethodFileCounter.fetchAndAdd(1) << '-'
<< randomSuffix;
}
Status SortedDataIndexAccessMethod::_handleDuplicateKey(
OperationContext* opCtx,
const KeyString::Value& dataKey,
const RecordIdHandlerFn& onDuplicateRecord) {
RecordId recordId = (KeyFormat::Long == _newInterface->rsKeyFormat())
? KeyString::decodeRecordIdLongAtEnd(dataKey.getBuffer(), dataKey.getSize())
: KeyString::decodeRecordIdStrAtEnd(dataKey.getBuffer(), dataKey.getSize());
if (onDuplicateRecord) {
return onDuplicateRecord(recordId);
}
BSONObj dupKey = KeyString::toBson(dataKey, getSortedDataInterface()->getOrdering());
return buildDupKeyErrorStatus(dupKey.getOwned(),
_indexCatalogEntry->getNSSFromCatalog(opCtx),
_descriptor->indexName(),
_descriptor->keyPattern(),
_descriptor->collation());
}
Status SortedDataIndexAccessMethod::_indexKeysOrWriteToSideTable(
OperationContext* opCtx,
const CollectionPtr& coll,
const KeyStringSet& keys,
const KeyStringSet& multikeyMetadataKeys,
const MultikeyPaths& multikeyPaths,
const BSONObj& obj,
const InsertDeleteOptions& options,
int64_t* keysInsertedOut) {
Status status = Status::OK();
if (_indexCatalogEntry->isHybridBuilding()) {
// The side table interface accepts only records that meet the criteria for this partial
// index.
// See SERVER-28975 and SERVER-39705 for details.
if (auto filter = _indexCatalogEntry->getFilterExpression()) {
if (!filter->matchesBSON(obj)) {
return Status::OK();
}
}
int64_t inserted = 0;
status = _indexCatalogEntry->indexBuildInterceptor()->sideWrite(
opCtx,
keys,
multikeyMetadataKeys,
multikeyPaths,
IndexBuildInterceptor::Op::kInsert,
&inserted);
if (keysInsertedOut) {
*keysInsertedOut += inserted;
}
} else {
// Ensure that our snapshot is compatible with the index's minimum visibile snapshot.
if (!feature_flags::gPointInTimeCatalogLookups.isEnabledAndIgnoreFCV()) {
const auto minVisibleTimestamp = _indexCatalogEntry->getMinimumVisibleSnapshot();
const auto readTimestamp =
opCtx->recoveryUnit()->getPointInTimeReadTimestamp(opCtx).value_or(
opCtx->recoveryUnit()->getCatalogConflictingTimestamp());
if (minVisibleTimestamp && !readTimestamp.isNull() &&
readTimestamp < *minVisibleTimestamp) {
throwWriteConflictException(
"Unable to read from a snapshot due to pending catalog changes.");
}
}
int64_t numInserted = 0;
status = insertKeysAndUpdateMultikeyPaths(
opCtx,
coll,
keys,
{multikeyMetadataKeys.begin(), multikeyMetadataKeys.end()},
multikeyPaths,
options,
nullptr,
&numInserted);
if (keysInsertedOut) {
*keysInsertedOut += numInserted;
}
}
return status;
}
void SortedDataIndexAccessMethod::_unindexKeysOrWriteToSideTable(
OperationContext* opCtx,
const NamespaceString& ns,
const KeyStringSet& keys,
const BSONObj& obj,
bool logIfError,
int64_t* const keysDeletedOut,
InsertDeleteOptions options, // copy!
CheckRecordId checkRecordId) {
options.logIfError = logIfError;
if (_indexCatalogEntry->isHybridBuilding()) {
// The side table interface accepts only records that meet the criteria for this partial
// index.
// See SERVER-28975 and SERVER-39705 for details.
if (auto filter = _indexCatalogEntry->getFilterExpression()) {
if (!filter->matchesBSON(obj)) {
return;
}
}
int64_t removed = 0;
fassert(31155,
_indexCatalogEntry->indexBuildInterceptor()->sideWrite(
opCtx, keys, {}, {}, IndexBuildInterceptor::Op::kDelete, &removed));
if (keysDeletedOut) {
*keysDeletedOut += removed;
}
return;
}
// On WiredTiger, we do blind unindexing of records for efficiency. However, when duplicates
// are allowed in unique indexes, WiredTiger does not do blind unindexing, and instead confirms
// that the recordid matches the element we are removing.
//
// We need to disable blind-deletes if 'checkRecordId' is explicitly set 'On'.
options.dupsAllowed = options.dupsAllowed || checkRecordId == CheckRecordId::On;
// Ensure that our snapshot is compatible with the index's minimum visibile snapshot.
if (!feature_flags::gPointInTimeCatalogLookups.isEnabledAndIgnoreFCV()) {
const auto minVisibleTimestamp = _indexCatalogEntry->getMinimumVisibleSnapshot();
const auto readTimestamp =
opCtx->recoveryUnit()->getPointInTimeReadTimestamp(opCtx).value_or(
opCtx->recoveryUnit()->getCatalogConflictingTimestamp());
if (minVisibleTimestamp && !readTimestamp.isNull() &&
readTimestamp < *minVisibleTimestamp) {
throwWriteConflictException(
"Unable to read from a snapshot due to pending catalog changes.");
}
}
int64_t removed = 0;
Status status = removeKeys(opCtx, keys, options, &removed);
if (!status.isOK()) {
LOGV2(20362,
"Couldn't unindex record",
"record"_attr = redact(obj),
"namespace"_attr = ns,
"error"_attr = redact(status));
}
if (keysDeletedOut) {
*keysDeletedOut += removed;
}
}
} // namespace mongo
#undef MONGO_LOGV2_DEFAULT_COMPONENT
#include "mongo/db/sorter/sorter.cpp"
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kCommand
MONGO_CREATE_SORTER(mongo::KeyString::Value, mongo::NullValue, mongo::BtreeExternalSortComparison);
|