/
multi_index_block.cpp
1063 lines (913 loc) · 46.1 KB
/
multi_index_block.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::kIndex
#include "mongo/platform/basic.h"
#include "mongo/db/catalog/multi_index_block.h"
#include <ostream>
#include "mongo/base/error_codes.h"
#include "mongo/bson/simple_bsonelement_comparator.h"
#include "mongo/db/catalog/collection.h"
#include "mongo/db/catalog/collection_catalog.h"
#include "mongo/db/catalog/multi_index_block_gen.h"
#include "mongo/db/catalog/uncommitted_collections.h"
#include "mongo/db/client.h"
#include "mongo/db/concurrency/write_conflict_exception.h"
#include "mongo/db/index/multikey_paths.h"
#include "mongo/db/multi_key_path_tracker.h"
#include "mongo/db/op_observer.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/query/collection_query_info.h"
#include "mongo/db/repl/repl_set_config.h"
#include "mongo/db/repl/replication_coordinator.h"
#include "mongo/db/repl/tenant_migration_conflict_info.h"
#include "mongo/db/storage/storage_options.h"
#include "mongo/db/storage/write_unit_of_work.h"
#include "mongo/logv2/log.h"
#include "mongo/util/assert_util.h"
#include "mongo/util/fail_point.h"
#include "mongo/util/log_and_backoff.h"
#include "mongo/util/progress_meter.h"
#include "mongo/util/quick_exit.h"
#include "mongo/util/scopeguard.h"
#include "mongo/util/uuid.h"
namespace mongo {
MONGO_FAIL_POINT_DEFINE(hangAfterSettingUpIndexBuild);
MONGO_FAIL_POINT_DEFINE(hangAfterSettingUpIndexBuildUnlocked);
MONGO_FAIL_POINT_DEFINE(hangAfterStartingIndexBuild);
MONGO_FAIL_POINT_DEFINE(hangAfterStartingIndexBuildUnlocked);
MONGO_FAIL_POINT_DEFINE(hangIndexBuildDuringCollectionScanPhaseBeforeInsertion);
MONGO_FAIL_POINT_DEFINE(hangIndexBuildDuringCollectionScanPhaseAfterInsertion);
MONGO_FAIL_POINT_DEFINE(leaveIndexBuildUnfinishedForShutdown);
namespace {
size_t getEachIndexBuildMaxMemoryUsageBytes(size_t numIndexSpecs) {
if (numIndexSpecs == 0) {
return 0;
}
return static_cast<std::size_t>(maxIndexBuildMemoryUsageMegabytes.load()) * 1024 * 1024 /
numIndexSpecs;
}
} // namespace
MultiIndexBlock::~MultiIndexBlock() {
invariant(_buildIsCleanedUp);
}
MultiIndexBlock::OnCleanUpFn MultiIndexBlock::kNoopOnCleanUpFn = []() {};
void MultiIndexBlock::abortIndexBuild(OperationContext* opCtx,
CollectionWriter& collection,
OnCleanUpFn onCleanUp) noexcept {
if (_collectionUUID) {
// init() was previously called with a collection pointer, so ensure that the same
// collection is being provided for clean up and the interface in not being abused.
invariant(_collectionUUID.get() == collection->uuid());
}
if (_buildIsCleanedUp) {
return;
}
auto nss = collection->ns();
UncommittedCollections::get(opCtx).invariantHasExclusiveAccessToCollection(opCtx, nss);
while (true) {
try {
WriteUnitOfWork wunit(opCtx);
// This cleans up all index builds. Because that may need to write, it is done inside of
// a WUOW. Nothing inside this block can fail, and it is made fatal if it does.
for (size_t i = 0; i < _indexes.size(); i++) {
_indexes[i].block->fail(opCtx, collection.getWritableCollection());
_indexes[i].block->finalizeTemporaryTables(
opCtx, TemporaryRecordStore::FinalizationAction::kDelete);
}
onCleanUp();
wunit.commit();
_buildIsCleanedUp = true;
return;
} catch (const WriteConflictException&) {
continue;
} catch (const DBException& e) {
if (e.toStatus() == ErrorCodes::ExceededMemoryLimit)
continue;
LOGV2_ERROR(20393,
"Caught exception while cleaning up partially built indexes: {e}",
"Caught exception while cleaning up partially built indexes",
"error"_attr = redact(e));
} catch (const std::exception& e) {
LOGV2_ERROR(20394,
"Caught exception while cleaning up partially built indexes: {e_what}",
"Caught exception while cleaning up partially built indexes",
"error"_attr = e.what());
} catch (...) {
LOGV2_ERROR(20395,
"Caught unknown exception while cleaning up partially built indexes");
}
fassertFailed(18644);
}
}
void MultiIndexBlock::ignoreUniqueConstraint() {
_ignoreUnique = true;
}
MultiIndexBlock::OnInitFn MultiIndexBlock::kNoopOnInitFn =
[](std::vector<BSONObj>& specs) -> Status { return Status::OK(); };
MultiIndexBlock::OnInitFn MultiIndexBlock::makeTimestampedIndexOnInitFn(OperationContext* opCtx,
const CollectionPtr& coll) {
return [opCtx, ns = coll->ns()](std::vector<BSONObj>& specs) -> Status {
opCtx->getServiceContext()->getOpObserver()->onStartIndexBuildSinglePhase(opCtx, ns);
return Status::OK();
};
}
StatusWith<std::vector<BSONObj>> MultiIndexBlock::init(OperationContext* opCtx,
CollectionWriter& collection,
const BSONObj& spec,
OnInitFn onInit) {
const auto indexes = std::vector<BSONObj>(1, spec);
return init(opCtx, collection, indexes, onInit, boost::none);
}
StatusWith<std::vector<BSONObj>> MultiIndexBlock::init(
OperationContext* opCtx,
CollectionWriter& collection,
const std::vector<BSONObj>& indexSpecs,
OnInitFn onInit,
const boost::optional<ResumeIndexInfo>& resumeInfo) {
invariant(opCtx->lockState()->isCollectionLockedForMode(collection->ns(), MODE_X),
str::stream() << "Collection " << collection->ns() << " with UUID "
<< collection->uuid() << " is holding the incorrect lock");
_collectionUUID = collection->uuid();
_buildIsCleanedUp = false;
invariant(_indexes.empty());
if (resumeInfo) {
_phase = resumeInfo->getPhase();
}
// Guarantees that exceptions cannot be returned from index builder initialization except for
// WriteConflictExceptions, which should be dealt with by the caller.
try {
WriteUnitOfWork wunit(opCtx);
// On rollback in init(), cleans up _indexes so that ~MultiIndexBlock doesn't try to clean
// up _indexes manually (since the changes were already rolled back). Due to this, it is
// thus legal to call init() again after it fails.
opCtx->recoveryUnit()->onRollback([this, opCtx]() {
for (auto& index : _indexes) {
index.block->finalizeTemporaryTables(
opCtx, TemporaryRecordStore::FinalizationAction::kDelete);
}
_indexes.clear();
_buildIsCleanedUp = true;
});
for (const auto& info : indexSpecs) {
if (info["background"].isBoolean() && !info["background"].Bool()) {
LOGV2(20383,
"Ignoring obsolete { background: false } index build option because all "
"indexes are built in the background with the hybrid method");
}
}
std::vector<BSONObj> indexInfoObjs;
indexInfoObjs.reserve(indexSpecs.size());
std::size_t eachIndexBuildMaxMemoryUsageBytes =
getEachIndexBuildMaxMemoryUsageBytes(indexSpecs.size());
// Initializing individual index build blocks below performs un-timestamped writes to the
// durable catalog. It's possible for the onInit function to set multiple timestamps
// depending on the index build codepath taken. Once to persist the index build entry in the
// 'config.system.indexBuilds' collection and another time to log the operation using
// onStartIndexBuild(). It's imperative that the durable catalog writes are timestamped at
// the same time as onStartIndexBuild() is to avoid rollback issues.
Status status = onInit(indexInfoObjs);
if (!status.isOK()) {
return status;
}
for (size_t i = 0; i < indexSpecs.size(); i++) {
BSONObj info = indexSpecs[i];
StatusWith<BSONObj> statusWithInfo =
collection->getIndexCatalog()->prepareSpecForCreate(
opCtx, collection.get(), info, resumeInfo);
Status status = statusWithInfo.getStatus();
if (!status.isOK()) {
// If we were given two identical indexes to build, we will run into an error trying
// to set up the same index a second time in this for-loop. This is the only way to
// encounter this error because callers filter out ready/in-progress indexes and
// start the build while holding a lock throughout.
if (status == ErrorCodes::IndexBuildAlreadyInProgress) {
invariant(indexSpecs.size() > 1,
str::stream()
<< "Collection: " << collection->ns() << " (" << _collectionUUID
<< "), Index spec: " << indexSpecs.front());
return {
ErrorCodes::OperationFailed,
"Cannot build two identical indexes. Try again without duplicate indexes."};
}
return status;
}
info = statusWithInfo.getValue();
indexInfoObjs.push_back(info);
boost::optional<IndexStateInfo> stateInfo;
auto& index = _indexes.emplace_back();
index.block =
std::make_unique<IndexBuildBlock>(collection->ns(), info, _method, _buildUUID);
if (resumeInfo) {
auto resumeInfoIndexes = resumeInfo->getIndexes();
// Find the resume information that corresponds to this spec.
auto stateInfoIt = std::find_if(resumeInfoIndexes.begin(),
resumeInfoIndexes.end(),
[&info](const IndexStateInfo& indexInfo) {
return info.woCompare(indexInfo.getSpec()) == 0;
});
uassert(ErrorCodes::NoSuchKey,
str::stream() << "Unable to locate resume information for " << info
<< " due to inconsistent resume information for index build "
<< _buildUUID << " on namespace " << collection->ns() << "("
<< _collectionUUID << ")",
stateInfoIt != resumeInfoIndexes.end());
stateInfo = *stateInfoIt;
status = index.block->initForResume(
opCtx, collection.getWritableCollection(), *stateInfo, resumeInfo->getPhase());
} else {
status = index.block->init(opCtx, collection.getWritableCollection());
}
if (!status.isOK())
return status;
auto indexCatalogEntry =
index.block->getEntry(opCtx, collection.getWritableCollection());
index.real = indexCatalogEntry->accessMethod();
status = index.real->initializeAsEmpty(opCtx);
if (!status.isOK())
return status;
index.bulk = index.real->initiateBulk(
eachIndexBuildMaxMemoryUsageBytes, stateInfo, collection->ns().db());
const IndexDescriptor* descriptor = indexCatalogEntry->descriptor();
collection->getIndexCatalog()->prepareInsertDeleteOptions(
opCtx, collection->ns(), descriptor, &index.options);
// Index builds always relax constraints and check for violations at commit-time.
index.options.getKeysMode = IndexAccessMethod::GetKeysMode::kRelaxConstraints;
index.options.dupsAllowed = true;
index.options.fromIndexBuilder = true;
LOGV2(20384,
"Index build: starting",
"buildUUID"_attr = _buildUUID,
"collectionUUID"_attr = _collectionUUID,
logAttrs(collection->ns()),
"properties"_attr = *descriptor,
"method"_attr = _method,
"maxTemporaryMemoryUsageMB"_attr =
eachIndexBuildMaxMemoryUsageBytes / 1024 / 1024);
index.filterExpression = indexCatalogEntry->getFilterExpression();
}
opCtx->recoveryUnit()->onCommit([ns = collection->ns(), this](auto commitTs) {
if (!_buildUUID) {
return;
}
LOGV2(20346,
"Index build: initialized",
"buildUUID"_attr = _buildUUID,
"collectionUUID"_attr = _collectionUUID,
logAttrs(ns),
"initializationTimestamp"_attr = commitTs);
});
wunit.commit();
return indexInfoObjs;
} catch (const WriteConflictException&) {
// Avoid converting WCE to Status.
throw;
} catch (const TenantMigrationConflictException&) {
// Avoid converting TenantMigrationConflictException to Status.
throw;
} catch (const TenantMigrationCommittedException&) {
// Avoid converting TenantMigrationCommittedException to Status.
throw;
} catch (...) {
return exceptionToStatus().withContext(
str::stream() << "Caught exception during index builder (" << _buildUUID
<< ") initialization on namespace" << collection->ns() << " ("
<< _collectionUUID << "). " << indexSpecs.size()
<< " index specs provided. First index spec: "
<< (indexSpecs.empty() ? BSONObj() : indexSpecs[0]));
}
}
Status MultiIndexBlock::insertAllDocumentsInCollection(
OperationContext* opCtx,
const CollectionPtr& collection,
boost::optional<RecordId> resumeAfterRecordId) {
invariant(!_buildIsCleanedUp);
invariant(opCtx->lockState()->isNoop() || !opCtx->lockState()->inAWriteUnitOfWork());
// UUIDs are not guaranteed during startup because the check happens after indexes are rebuilt.
if (_collectionUUID) {
invariant(_collectionUUID.get() == collection->uuid());
}
// Refrain from persisting any multikey updates as a result from building the index. Instead,
// accumulate them in the `MultikeyPathTracker` and do the write as part of the update that
// commits the index.
auto stopTracker = makeGuard(
[this, opCtx] { MultikeyPathTracker::get(opCtx).stopTrackingMultikeyPathInfo(); });
if (MultikeyPathTracker::get(opCtx).isTrackingMultikeyPathInfo()) {
stopTracker.dismiss();
}
MultikeyPathTracker::get(opCtx).startTrackingMultikeyPathInfo();
const char* curopMessage = "Index Build: scanning collection";
const auto numRecords = collection->numRecords(opCtx);
ProgressMeterHolder progress;
{
stdx::unique_lock<Client> lk(*opCtx->getClient());
progress.set(CurOp::get(opCtx)->setProgress_inlock(curopMessage, numRecords));
}
hangAfterSettingUpIndexBuild.executeIf(
[buildUUID = _buildUUID](const BSONObj& data) {
// Hang the build after the curOP info is set up.
LOGV2(20387,
"Hanging index build due to failpoint 'hangAfterSettingUpIndexBuild'",
"buildUUID"_attr = buildUUID);
hangAfterSettingUpIndexBuild.pauseWhileSet();
},
[buildUUID = _buildUUID](const BSONObj& data) {
if (!buildUUID || !data.hasField("buildUUIDs")) {
return true;
}
auto buildUUIDs = data.getObjectField("buildUUIDs");
return std::any_of(
buildUUIDs.begin(), buildUUIDs.end(), [buildUUID = *buildUUID](const auto& elem) {
return UUID::parse(elem.String()) == buildUUID;
});
});
if (MONGO_unlikely(hangAfterSettingUpIndexBuildUnlocked.shouldFail())) {
uassert(4585200, "failpoint may not be set on foreground indexes", isBackgroundBuilding());
// Unlock before hanging so replication recognizes we've completed.
collection.yield();
Locker::LockSnapshot lockInfo;
invariant(opCtx->lockState()->saveLockStateAndUnlock(&lockInfo));
LOGV2(4585201,
"Hanging index build with no locks due to "
"'hangAfterSettingUpIndexBuildUnlocked' failpoint");
hangAfterSettingUpIndexBuildUnlocked.pauseWhileSet();
opCtx->lockState()->restoreLockState(opCtx, lockInfo);
opCtx->recoveryUnit()->abandonSnapshot();
collection.restore();
}
// Hint to the storage engine that this collection scan should not keep data in the cache.
bool readOnce = useReadOnceCursorsForIndexBuilds.load();
opCtx->recoveryUnit()->setReadOnce(readOnce);
size_t numScanRestarts = 0;
bool restartCollectionScan = false;
do {
restartCollectionScan = false;
progress->reset(collection->numRecords(opCtx));
Timer timer;
try {
// Resumable index builds can only be resumed prior to the oplog recovery phase of
// startup. When restarting the collection scan, any saved index build progress is lost.
_doCollectionScan(opCtx,
collection,
numScanRestarts == 0 ? resumeAfterRecordId : boost::none,
&progress);
LOGV2(20391,
"Index build: collection scan done",
"buildUUID"_attr = _buildUUID,
"collectionUUID"_attr = _collectionUUID,
logAttrs(collection->ns()),
"totalRecords"_attr = progress->hits(),
"readSource"_attr =
RecoveryUnit::toString(opCtx->recoveryUnit()->getTimestampReadSource()),
"duration"_attr = duration_cast<Milliseconds>(Seconds(timer.seconds())));
} catch (DBException& ex) {
if (ex.code() == ErrorCodes::ReadConcernMajorityNotAvailableYet ||
ex.code() == ErrorCodes::CappedPositionLost) {
// Forced replica set re-configs will clear the majority committed snapshot,
// which may be used by the collection scan. The collection scan will restart
// from the beginning in this case. Capped cursors are invalidated when the document
// they were positioned on gets deleted. The collection scan will restart in both
// cases.
restartCollectionScan = true;
logAndBackoff(
5470300,
::mongo::logv2::LogComponent::kIndex,
logv2::LogSeverity::Info(),
++numScanRestarts,
"Index build: collection scan restarting",
"buildUUID"_attr = _buildUUID,
"collectionUUID"_attr = _collectionUUID,
"totalRecords"_attr = progress->hits(),
"duration"_attr = duration_cast<Milliseconds>(Seconds(timer.seconds())),
"phase"_attr = IndexBuildPhase_serializer(_phase),
"collectionScanPosition"_attr = _lastRecordIdInserted,
"readSource"_attr =
RecoveryUnit::toString(opCtx->recoveryUnit()->getTimestampReadSource()),
"error"_attr = ex);
_lastRecordIdInserted = boost::none;
for (auto& index : _indexes) {
index.bulk = index.real->initiateBulk(
getEachIndexBuildMaxMemoryUsageBytes(_indexes.size()),
/*stateInfo=*/boost::none,
collection->ns().db());
}
} else {
if (ex.isA<ErrorCategory::Interruption>() ||
ex.isA<ErrorCategory::ShutdownError>() ||
ErrorCodes::IndexBuildAborted == ex.code()) {
// If the collection scan is stopped due to an interrupt or shutdown event, we
// leave the internal state intact to ensure we have the correct information for
// resuming this index build during startup and rollback.
} else {
// Restore pre-collection scan state.
_phase = IndexBuildPhaseEnum::kInitialized;
}
auto readSource = opCtx->recoveryUnit()->getTimestampReadSource();
LOGV2(4984704,
"Index build: collection scan stopped",
"buildUUID"_attr = _buildUUID,
"collectionUUID"_attr = _collectionUUID,
"totalRecords"_attr = progress->hits(),
"duration"_attr = duration_cast<Milliseconds>(Seconds(timer.seconds())),
"phase"_attr = IndexBuildPhase_serializer(_phase),
"collectionScanPosition"_attr = _lastRecordIdInserted,
"readSource"_attr = RecoveryUnit::toString(readSource),
"error"_attr = ex);
ex.addContext(str::stream()
<< "collection scan stopped. totalRecords: " << progress->hits()
<< "; durationMillis: "
<< duration_cast<Milliseconds>(Seconds(timer.seconds()))
<< "; phase: " << IndexBuildPhase_serializer(_phase)
<< "; collectionScanPosition: " << _lastRecordIdInserted
<< "; readSource: " << RecoveryUnit::toString(readSource));
return ex.toStatus();
}
}
} while (restartCollectionScan);
if (MONGO_unlikely(leaveIndexBuildUnfinishedForShutdown.shouldFail())) {
LOGV2(20389,
"Index build interrupted due to 'leaveIndexBuildUnfinishedForShutdown' failpoint. "
"Mimicking shutdown error code");
return Status(
ErrorCodes::InterruptedAtShutdown,
"background index build interrupted due to failpoint. returning a shutdown error.");
}
if (MONGO_unlikely(hangAfterStartingIndexBuildUnlocked.shouldFail())) {
// Unlock before hanging so replication recognizes we've completed.
collection.yield();
Locker::LockSnapshot lockInfo;
invariant(opCtx->lockState()->saveLockStateAndUnlock(&lockInfo));
LOGV2(20390,
"Hanging index build with no locks due to "
"'hangAfterStartingIndexBuildUnlocked' failpoint");
hangAfterStartingIndexBuildUnlocked.pauseWhileSet();
if (isBackgroundBuilding()) {
opCtx->lockState()->restoreLockState(opCtx, lockInfo);
opCtx->recoveryUnit()->abandonSnapshot();
} else {
invariant(false,
"the hangAfterStartingIndexBuildUnlocked failpoint can't be turned off for "
"foreground index builds");
}
collection.restore();
}
progress.finished();
Status ret = dumpInsertsFromBulk(opCtx, collection);
if (!ret.isOK())
return ret;
return Status::OK();
}
void MultiIndexBlock::_doCollectionScan(OperationContext* opCtx,
const CollectionPtr& collection,
boost::optional<RecordId> resumeAfterRecordId,
ProgressMeterHolder* progress) {
PlanYieldPolicy::YieldPolicy yieldPolicy;
if (isBackgroundBuilding()) {
yieldPolicy = PlanYieldPolicy::YieldPolicy::YIELD_AUTO;
} else {
yieldPolicy = PlanYieldPolicy::YieldPolicy::WRITE_CONFLICT_RETRY_ONLY;
}
auto exec = collection->makePlanExecutor(
opCtx, collection, yieldPolicy, Collection::ScanDirection::kForward, resumeAfterRecordId);
// The phase will be kCollectionScan when resuming an index build from the collection
// scan phase.
invariant(_phase == IndexBuildPhaseEnum::kInitialized ||
_phase == IndexBuildPhaseEnum::kCollectionScan,
IndexBuildPhase_serializer(_phase).toString());
_phase = IndexBuildPhaseEnum::kCollectionScan;
BSONObj objToIndex;
RecordId loc;
PlanExecutor::ExecState state;
while (PlanExecutor::ADVANCED == (state = exec->getNext(&objToIndex, &loc)) ||
MONGO_unlikely(hangAfterStartingIndexBuild.shouldFail())) {
opCtx->checkForInterrupt();
if (PlanExecutor::ADVANCED != state) {
continue;
}
progress->get()->setTotalWhileRunning(collection->numRecords(opCtx));
uassertStatusOK(
_failPointHangDuringBuild(opCtx,
&hangIndexBuildDuringCollectionScanPhaseBeforeInsertion,
"before",
objToIndex,
(*progress)->hits()));
// The external sorter is not part of the storage engine and therefore does not need
// a WriteUnitOfWork to write keys.
uassertStatusOK(_insert(opCtx, collection, objToIndex, loc));
_failPointHangDuringBuild(opCtx,
&hangIndexBuildDuringCollectionScanPhaseAfterInsertion,
"after",
objToIndex,
(*progress)->hits())
.ignore();
// Go to the next document.
progress->hit();
}
}
Status MultiIndexBlock::insertSingleDocumentForInitialSyncOrRecovery(
OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& doc,
const RecordId& loc) {
return _insert(opCtx, collection, doc, loc);
}
Status MultiIndexBlock::_insert(OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& doc,
const RecordId& loc) {
invariant(!_buildIsCleanedUp);
for (size_t i = 0; i < _indexes.size(); i++) {
if (_indexes[i].filterExpression && !_indexes[i].filterExpression->matchesBSON(doc)) {
continue;
}
Status idxStatus = Status::OK();
// When calling insert, BulkBuilderImpl's Sorter performs file I/O that may result in an
// exception.
try {
idxStatus = _indexes[i].bulk->insert(opCtx, collection, doc, loc, _indexes[i].options);
} catch (...) {
return exceptionToStatus();
}
if (!idxStatus.isOK())
return idxStatus;
}
_lastRecordIdInserted = loc;
return Status::OK();
}
Status MultiIndexBlock::dumpInsertsFromBulk(OperationContext* opCtx,
const CollectionPtr& collection) {
return dumpInsertsFromBulk(opCtx, collection, nullptr);
}
Status MultiIndexBlock::dumpInsertsFromBulk(
OperationContext* opCtx,
const CollectionPtr& collection,
const IndexAccessMethod::RecordIdHandlerFn& onDuplicateRecord) {
opCtx->checkForInterrupt();
invariant(!_buildIsCleanedUp);
invariant(opCtx->lockState()->isNoop() || !opCtx->lockState()->inAWriteUnitOfWork());
// Initial sync adds documents to the sorter using
// insertSingleDocumentForInitialSyncOrRecovery() instead of delegating to
// insertDocumentsInCollection() to scan and insert the contents of the collection.
// Therefore, it is possible for the phase of this MultiIndexBlock to be kInitialized
// rather than kCollection when this function is called. The phase will be kBulkLoad when
// resuming an index build from the bulk load phase.
invariant(_phase == IndexBuildPhaseEnum::kInitialized ||
_phase == IndexBuildPhaseEnum::kCollectionScan ||
_phase == IndexBuildPhaseEnum::kBulkLoad,
IndexBuildPhase_serializer(_phase).toString());
_phase = IndexBuildPhaseEnum::kBulkLoad;
for (size_t i = 0; i < _indexes.size(); i++) {
// When onDuplicateRecord is passed, 'dupsAllowed' should be passed to reflect whether or
// not the index is unique.
bool dupsAllowed = (onDuplicateRecord)
? !_indexes[i].block->getEntry(opCtx, collection)->descriptor()->unique()
: _indexes[i].options.dupsAllowed;
const IndexCatalogEntry* entry = _indexes[i].block->getEntry(opCtx, collection);
LOGV2_DEBUG(20392,
1,
"Index build: inserting from external sorter into index",
"index"_attr = entry->descriptor()->indexName(),
"buildUUID"_attr = _buildUUID);
// SERVER-41918 This call to commitBulk() results in file I/O that may result in an
// exception.
try {
Status status = _indexes[i].real->commitBulk(
opCtx,
_indexes[i].bulk.get(),
dupsAllowed,
[=](const KeyString::Value& duplicateKey) {
// Do not record duplicates when explicitly ignored. This may be the case on
// secondaries.
return writeConflictRetry(
opCtx, "recordingDuplicateKey", entry->getNSSFromCatalog(opCtx).ns(), [&] {
if (dupsAllowed && !onDuplicateRecord && !_ignoreUnique &&
entry->indexBuildInterceptor()) {
WriteUnitOfWork wuow(opCtx);
Status status = entry->indexBuildInterceptor()->recordDuplicateKey(
opCtx, duplicateKey);
if (!status.isOK()) {
return status;
}
wuow.commit();
}
return Status::OK();
});
},
onDuplicateRecord);
if (!status.isOK()) {
return status;
}
} catch (...) {
return exceptionToStatus();
}
}
return Status::OK();
}
Status MultiIndexBlock::drainBackgroundWrites(
OperationContext* opCtx,
RecoveryUnit::ReadSource readSource,
IndexBuildInterceptor::DrainYieldPolicy drainYieldPolicy) {
invariant(!_buildIsCleanedUp);
invariant(!opCtx->lockState()->inAWriteUnitOfWork());
// Background writes are drained three times (once without blocking writes and twice blocking
// writes), so we may either be coming from the bulk load phase or be already in the drain
// writes phase.
invariant(_phase == IndexBuildPhaseEnum::kBulkLoad ||
_phase == IndexBuildPhaseEnum::kDrainWrites,
IndexBuildPhase_serializer(_phase).toString());
_phase = IndexBuildPhaseEnum::kDrainWrites;
ReadSourceScope readSourceScope(opCtx, readSource);
const CollectionPtr& coll =
CollectionCatalog::get(opCtx)->lookupCollectionByUUID(opCtx, _collectionUUID.get());
// Drain side-writes table for each index. This only drains what is visible. Assuming intent
// locks are held on the user collection, more writes can come in after this drain completes.
// Callers are responsible for stopping writes by holding an S or X lock while draining before
// completing the index build.
for (size_t i = 0; i < _indexes.size(); i++) {
auto interceptor = _indexes[i].block->getEntry(opCtx, coll)->indexBuildInterceptor();
if (!interceptor)
continue;
// Track duplicates for later constraint checking for all index builds, except when
// _ignoreUnique is set explicitly.
auto trackDups = !_ignoreUnique ? IndexBuildInterceptor::TrackDuplicates::kTrack
: IndexBuildInterceptor::TrackDuplicates::kNoTrack;
auto status = interceptor->drainWritesIntoIndex(
opCtx, coll, _indexes[i].options, trackDups, drainYieldPolicy);
if (!status.isOK()) {
return status;
}
}
return Status::OK();
}
Status MultiIndexBlock::retrySkippedRecords(OperationContext* opCtx,
const CollectionPtr& collection) {
invariant(!_buildIsCleanedUp);
for (auto&& index : _indexes) {
auto interceptor = index.block->getEntry(opCtx, collection)->indexBuildInterceptor();
if (!interceptor)
continue;
auto status = interceptor->retrySkippedRecords(opCtx, collection);
if (!status.isOK()) {
return status;
}
}
return Status::OK();
}
Status MultiIndexBlock::checkConstraints(OperationContext* opCtx, const CollectionPtr& collection) {
invariant(!_buildIsCleanedUp);
// For each index that may be unique, check that no recorded duplicates still exist. This can
// only check what is visible on the index. Callers are responsible for ensuring all writes to
// the collection are visible.
for (size_t i = 0; i < _indexes.size(); i++) {
auto interceptor = _indexes[i].block->getEntry(opCtx, collection)->indexBuildInterceptor();
if (!interceptor)
continue;
auto status = interceptor->checkDuplicateKeyConstraints(opCtx);
if (!status.isOK()) {
return status;
}
}
return Status::OK();
}
MultiIndexBlock::OnCreateEachFn MultiIndexBlock::kNoopOnCreateEachFn = [](const BSONObj& spec) {};
MultiIndexBlock::OnCommitFn MultiIndexBlock::kNoopOnCommitFn = []() {};
Status MultiIndexBlock::commit(OperationContext* opCtx,
Collection* collection,
OnCreateEachFn onCreateEach,
OnCommitFn onCommit) {
invariant(!_buildIsCleanedUp);
invariant(opCtx->lockState()->isCollectionLockedForMode(collection->ns(), MODE_X),
str::stream() << "Collection " << collection->ns() << " with UUID "
<< collection->uuid() << " is holding the incorrect lock");
// UUIDs are not guaranteed during startup because the check happens after indexes are rebuilt.
if (_collectionUUID) {
invariant(_collectionUUID.get() == collection->uuid());
}
// Do not interfere with writing multikey information when committing index builds.
auto restartTracker = makeGuard(
[this, opCtx] { MultikeyPathTracker::get(opCtx).startTrackingMultikeyPathInfo(); });
if (!MultikeyPathTracker::get(opCtx).isTrackingMultikeyPathInfo()) {
restartTracker.dismiss();
}
MultikeyPathTracker::get(opCtx).stopTrackingMultikeyPathInfo();
for (size_t i = 0; i < _indexes.size(); i++) {
onCreateEach(_indexes[i].block->getSpec());
// Do this before calling success(), which unsets the interceptor pointer on the index
// catalog entry. The interceptor will write multikey metadata keys into the index during
// IndexBuildInterceptor::sideWrite, so we only need to pass the cached MultikeyPaths into
// IndexCatalogEntry::setMultikey here.
auto indexCatalogEntry = _indexes[i].block->getEntry(opCtx, collection);
auto interceptor = indexCatalogEntry->indexBuildInterceptor();
if (interceptor) {
auto multikeyPaths = interceptor->getMultikeyPaths();
if (multikeyPaths) {
indexCatalogEntry->setMultikey(opCtx, collection, {}, multikeyPaths.get());
}
}
_indexes[i].block->success(opCtx, collection);
// The bulk builder will track multikey information itself, and will write cached multikey
// metadata keys into the index just before committing. We therefore only need to pass the
// MultikeyPaths into IndexCatalogEntry::setMultikey here.
const auto& bulkBuilder = _indexes[i].bulk;
if (bulkBuilder->isMultikey()) {
indexCatalogEntry->setMultikey(opCtx, collection, {}, bulkBuilder->getMultikeyPaths());
}
// The commit() function can be called multiple times on write conflict errors. Dropping the
// temp tables cannot be rolled back, so do it only after the WUOW commits.
opCtx->recoveryUnit()->onCommit([opCtx, i, this](auto commitTs) {
_indexes[i].block->finalizeTemporaryTables(
opCtx, TemporaryRecordStore::FinalizationAction::kDelete);
});
}
onCommit();
CollectionQueryInfo::get(collection).clearQueryCache(opCtx, collection);
opCtx->recoveryUnit()->onCommit(
[this](boost::optional<Timestamp> commitTime) { _buildIsCleanedUp = true; });
return Status::OK();
}
bool MultiIndexBlock::isBackgroundBuilding() const {
return _method == IndexBuildMethod::kHybrid;
}
void MultiIndexBlock::setIndexBuildMethod(IndexBuildMethod indexBuildMethod) {
_method = indexBuildMethod;
}
void MultiIndexBlock::abortWithoutCleanup(OperationContext* opCtx,
const CollectionPtr& collection,
bool isResumable) {
invariant(!_buildIsCleanedUp);
UninterruptibleLockGuard noInterrupt(opCtx->lockState());
// Lock if it's not already locked, to ensure storage engine cannot be destructed out from
// underneath us.
boost::optional<Lock::GlobalLock> lk;
if (!opCtx->lockState()->isWriteLocked()) {
lk.emplace(opCtx, MODE_IX);
}
auto action = TemporaryRecordStore::FinalizationAction::kDelete;
if (isResumable) {
invariant(_buildUUID);
invariant(_method == IndexBuildMethod::kHybrid);
// Index builds do not yield locks during the bulk load phase so it is not possible for
// rollback to interrupt an index build during this phase.
if (!ErrorCodes::isShutdownError(opCtx->checkForInterruptNoAssert())) {
invariant(IndexBuildPhaseEnum::kBulkLoad != _phase, str::stream() << *_buildUUID);
}
_writeStateToDisk(opCtx, collection);
action = TemporaryRecordStore::FinalizationAction::kKeep;
}
for (auto& index : _indexes) {
index.block->finalizeTemporaryTables(opCtx, action);
}
_buildIsCleanedUp = true;
}
void MultiIndexBlock::_writeStateToDisk(OperationContext* opCtx,
const CollectionPtr& collection) const {
auto obj = _constructStateObject(opCtx, collection);
auto rs = opCtx->getServiceContext()
->getStorageEngine()
->makeTemporaryRecordStoreForResumableIndexBuild(opCtx);
WriteUnitOfWork wuow(opCtx);
auto status = rs->rs()->insertRecord(opCtx, obj.objdata(), obj.objsize(), Timestamp());
if (!status.isOK()) {
LOGV2_ERROR(4841501,
"Index build: failed to write resumable state to disk",
"buildUUID"_attr = _buildUUID,
"collectionUUID"_attr = _collectionUUID,
logAttrs(collection->ns()),
"details"_attr = obj,
"error"_attr = status.getStatus());
dassert(status,
str::stream() << "Failed to write resumable index build state to disk. UUID: "
<< _buildUUID);
rs->finalizeTemporaryTable(opCtx, TemporaryRecordStore::FinalizationAction::kDelete);
return;
}
wuow.commit();
LOGV2(4841502,
"Index build: wrote resumable state to disk",
"buildUUID"_attr = _buildUUID,
"collectionUUID"_attr = _collectionUUID,
logAttrs(collection->ns()),
"details"_attr = obj);
rs->finalizeTemporaryTable(opCtx, TemporaryRecordStore::FinalizationAction::kKeep);
}
BSONObj MultiIndexBlock::_constructStateObject(OperationContext* opCtx,
const CollectionPtr& collection) const {
BSONObjBuilder builder;
_buildUUID->appendToBuilder(&builder, "_id");
builder.append("phase", IndexBuildPhase_serializer(_phase));
if (_collectionUUID) {
_collectionUUID->appendToBuilder(&builder, "collectionUUID");
}
// We can be interrupted by shutdown before inserting the first document from the collection
// scan, in which case there is no _lastRecordIdInserted.
if (_phase == IndexBuildPhaseEnum::kCollectionScan && _lastRecordIdInserted) {
_lastRecordIdInserted->serializeToken("collectionScanPosition", &builder);
}
BSONArrayBuilder indexesArray(builder.subarrayStart("indexes"));
for (const auto& index : _indexes) {
BSONObjBuilder indexInfo(indexesArray.subobjStart());
if (_phase != IndexBuildPhaseEnum::kDrainWrites) {
// Persist the data to disk so that we see all of the data that has been inserted into
// the Sorter.
auto state = index.bulk->persistDataForShutdown();
indexInfo.append("fileName", state.fileName);
indexInfo.append("numKeys", index.bulk->getKeysInserted());
BSONArrayBuilder ranges(indexInfo.subarrayStart("ranges"));
for (const auto& rangeInfo : state.ranges) {
BSONObjBuilder range(ranges.subobjStart());
range.append("startOffset", rangeInfo.getStartOffset());
range.append("endOffset", rangeInfo.getEndOffset());
range.append("checksum", rangeInfo.getChecksum());
}
}
auto indexBuildInterceptor =
index.block->getEntry(opCtx, collection)->indexBuildInterceptor();
indexInfo.append("sideWritesTable", indexBuildInterceptor->getSideWritesTableIdent());
if (auto duplicateKeyTrackerTableIdent =
indexBuildInterceptor->getDuplicateKeyTrackerTableIdent())
indexInfo.append("duplicateKeyTrackerTable", *duplicateKeyTrackerTableIdent);
if (auto skippedRecordTrackerTableIdent =
indexBuildInterceptor->getSkippedRecordTracker()->getTableIdent())
indexInfo.append("skippedRecordTrackerTable", *skippedRecordTrackerTableIdent);
indexInfo.append("spec", index.block->getSpec());
indexInfo.append("isMultikey", index.bulk->isMultikey());