/
index_builds_coordinator.cpp
2653 lines (2320 loc) · 122 KB
/
index_builds_coordinator.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/index_builds_coordinator.h"
#include "mongo/db/catalog/collection_catalog.h"
#include "mongo/db/catalog/commit_quorum_options.h"
#include "mongo/db/catalog/database_holder.h"
#include "mongo/db/catalog/index_build_entry_gen.h"
#include "mongo/db/catalog/index_timestamp_helper.h"
#include "mongo/db/catalog/uncommitted_collections.h"
#include "mongo/db/catalog_raii.h"
#include "mongo/db/concurrency/locker.h"
#include "mongo/db/concurrency/replication_state_transition_lock_guard.h"
#include "mongo/db/concurrency/write_conflict_exception.h"
#include "mongo/db/curop.h"
#include "mongo/db/db_raii.h"
#include "mongo/db/index/wildcard_key_generator.h"
#include "mongo/db/index_build_entry_helpers.h"
#include "mongo/db/op_observer.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/repl/member_state.h"
#include "mongo/db/repl/replication_coordinator.h"
#include "mongo/db/repl/timestamp_block.h"
#include "mongo/db/s/collection_sharding_state.h"
#include "mongo/db/s/database_sharding_state.h"
#include "mongo/db/server_options.h"
#include "mongo/db/server_recovery.h"
#include "mongo/db/service_context.h"
#include "mongo/db/storage/durable_catalog.h"
#include "mongo/logv2/log.h"
#include "mongo/s/shard_key_pattern.h"
#include "mongo/util/assert_util.h"
#include "mongo/util/str.h"
#include <boost/iterator/transform_iterator.hpp>
namespace mongo {
MONGO_FAIL_POINT_DEFINE(hangAfterIndexBuildFirstDrain);
MONGO_FAIL_POINT_DEFINE(hangAfterIndexBuildSecondDrain);
MONGO_FAIL_POINT_DEFINE(hangAfterIndexBuildDumpsInsertsFromBulk);
MONGO_FAIL_POINT_DEFINE(hangAfterInitializingIndexBuild);
MONGO_FAIL_POINT_DEFINE(hangBeforeCompletingAbort);
MONGO_FAIL_POINT_DEFINE(failIndexBuildOnCommit);
MONGO_FAIL_POINT_DEFINE(hangIndexBuildBeforeAbortCleanUp);
MONGO_FAIL_POINT_DEFINE(hangIndexBuildOnStepUp);
namespace {
constexpr StringData kCreateIndexesFieldName = "createIndexes"_sd;
constexpr StringData kCommitIndexBuildFieldName = "commitIndexBuild"_sd;
constexpr StringData kAbortIndexBuildFieldName = "abortIndexBuild"_sd;
constexpr StringData kIndexesFieldName = "indexes"_sd;
constexpr StringData kKeyFieldName = "key"_sd;
constexpr StringData kUniqueFieldName = "unique"_sd;
/**
* Checks if unique index specification is compatible with sharding configuration.
*/
void checkShardKeyRestrictions(OperationContext* opCtx,
const NamespaceString& nss,
const BSONObj& newIdxKey) {
UncommittedCollections::get(opCtx).invariantHasExclusiveAccessToCollection(opCtx, nss);
const auto collDesc = CollectionShardingState::get(opCtx, nss)->getCollectionDescription(opCtx);
if (!collDesc.isSharded())
return;
const ShardKeyPattern shardKeyPattern(collDesc.getKeyPattern());
uassert(ErrorCodes::CannotCreateIndex,
str::stream() << "cannot create unique index over " << newIdxKey
<< " with shard key pattern " << shardKeyPattern.toBSON(),
shardKeyPattern.isUniqueIndexCompatible(newIdxKey));
}
/**
* Returns true if we should build the indexes an empty collection using the IndexCatalog and
* bypass the index build registration.
*/
bool shouldBuildIndexesOnEmptyCollectionSinglePhased(OperationContext* opCtx,
Collection* collection,
IndexBuildProtocol protocol) {
const auto& nss = collection->ns();
invariant(opCtx->lockState()->isCollectionLockedForMode(nss, MODE_X), str::stream() << nss);
auto replCoord = repl::ReplicationCoordinator::get(opCtx);
// Check whether the replica set member's config has {buildIndexes:false} set, which means
// we are not allowed to build non-_id indexes on this server.
if (!replCoord->buildsIndexes()) {
return false;
}
// Secondaries should not bypass index build registration (and _runIndexBuild()) for two phase
// index builds because they need to report index build progress to the primary per commit
// quorum.
if (IndexBuildProtocol::kTwoPhase == protocol && replCoord->getSettings().usingReplSets() &&
!replCoord->canAcceptWritesFor(opCtx, nss)) {
return false;
}
// We use the fast count information, through Collection::numRecords(), to determine if the
// collection is empty. However, this information is either unavailable or inaccurate when the
// node is in certain replication states, such as recovery or rollback. In these cases, we
// have to build the index by scanning the collection.
auto memberState = replCoord->getMemberState();
if (memberState.rollback()) {
return false;
}
if (inReplicationRecovery(opCtx->getServiceContext())) {
return false;
}
// Now, it's fine to trust Collection::isEmpty().
// Fast counts are prone to both false positives and false negatives on unclean shutdowns. False
// negatives can cause to skip index building. And, false positives can cause mismatch in number
// of index entries among the nodes in the replica set. So, verify the collection is really
// empty by opening the WT cursor and reading the first document.
return collection->isEmpty(opCtx);
}
/*
* Determines whether to skip the index build state transition check.
* Index builder not using ReplIndexBuildState::waitForNextAction to signal primary and secondaries
* to commit or abort signal will violate index build state transition. So, we should skip state
* transition verification. Otherwise, we would invariant.
*/
bool shouldSkipIndexBuildStateTransitionCheck(OperationContext* opCtx,
IndexBuildProtocol protocol) {
const auto replCoord = repl::ReplicationCoordinator::get(opCtx);
if (replCoord->getSettings().usingReplSets() && protocol == IndexBuildProtocol::kTwoPhase) {
return false;
}
return true;
}
/**
* Removes the index build from the config.system.indexBuilds collection after the primary has
* written the commitIndexBuild or abortIndexBuild oplog entry.
*/
void removeIndexBuildEntryAfterCommitOrAbort(OperationContext* opCtx,
const NamespaceStringOrUUID& dbAndUUID,
const ReplIndexBuildState& replState) {
if (IndexBuildProtocol::kSinglePhase == replState.protocol) {
return;
}
auto replCoord = repl::ReplicationCoordinator::get(opCtx);
if (!replCoord->canAcceptWritesFor(opCtx, dbAndUUID)) {
return;
}
auto status = indexbuildentryhelpers::removeIndexBuildEntry(opCtx, replState.buildUUID);
// If we fail to remove the document from config.system.indexBuilds, it is because the document
// or collection is missing. In any case, we do not need to fail the commit or abort operation.
// TODO(SERVER-47323): Do not ignore removeIndexBuildEntry() errors. Convert to fatal assertion.
if (!status.isOK()) {
LOGV2(4763501,
"Unable to remove index build from system collection. Ignoring error",
"buildUUID"_attr = replState.buildUUID,
"collectionUUID"_attr = replState.collectionUUID,
"error"_attr = status);
}
}
/**
* Replicates a commitIndexBuild oplog entry for two-phase builds, which signals downstream
* secondary nodes to commit the index build.
*/
void onCommitIndexBuild(OperationContext* opCtx,
const NamespaceString& nss,
std::shared_ptr<ReplIndexBuildState> replState) {
const auto& buildUUID = replState->buildUUID;
auto skipCheck = shouldSkipIndexBuildStateTransitionCheck(opCtx, replState->protocol);
opCtx->recoveryUnit()->onCommit([replState, skipCheck](boost::optional<Timestamp> commitTime) {
stdx::unique_lock<Latch> lk(replState->mutex);
replState->indexBuildState.setState(IndexBuildState::kCommitted, skipCheck);
});
if (IndexBuildProtocol::kSinglePhase == replState->protocol) {
return;
}
invariant(IndexBuildProtocol::kTwoPhase == replState->protocol,
str::stream() << "onCommitIndexBuild: " << buildUUID);
invariant(opCtx->lockState()->isWriteLocked(),
str::stream() << "onCommitIndexBuild: " << buildUUID);
auto opObserver = opCtx->getServiceContext()->getOpObserver();
const auto& collUUID = replState->collectionUUID;
const auto& indexSpecs = replState->indexSpecs;
auto fromMigrate = false;
// Since two phase index builds are allowed to survive replication state transitions, we should
// check if the node is currently a primary before attempting to write to the oplog.
auto replCoord = repl::ReplicationCoordinator::get(opCtx);
if (!replCoord->canAcceptWritesFor(opCtx, nss)) {
invariant(!opCtx->recoveryUnit()->getCommitTimestamp().isNull(),
str::stream() << "commitIndexBuild: " << buildUUID);
return;
}
opObserver->onCommitIndexBuild(opCtx, nss, collUUID, buildUUID, indexSpecs, fromMigrate);
}
/**
* Replicates an abortIndexBuild oplog entry for two-phase builds, which signals downstream
* secondary nodes to abort the index build.
*/
void onAbortIndexBuild(OperationContext* opCtx,
const NamespaceString& nss,
ReplIndexBuildState& replState,
const Status& cause) {
if (IndexBuildProtocol::kTwoPhase != replState.protocol) {
return;
}
invariant(opCtx->lockState()->isWriteLocked(), replState.buildUUID.toString());
auto opObserver = opCtx->getServiceContext()->getOpObserver();
auto collUUID = replState.collectionUUID;
auto fromMigrate = false;
opObserver->onAbortIndexBuild(
opCtx, nss, collUUID, replState.buildUUID, replState.indexSpecs, cause, fromMigrate);
}
/**
* We do not need synchronization with step up and step down. Dropping the RSTL is important because
* otherwise if we held the RSTL it would create deadlocks with prepared transactions on step up and
* step down. A deadlock could result if the index build was attempting to acquire a Collection S
* or X lock while a prepared transaction held a Collection IX lock, and a step down was waiting to
* acquire the RSTL in mode X.
*/
void unlockRSTL(OperationContext* opCtx) {
invariant(opCtx->lockState()->unlockRSTLforPrepare());
invariant(!opCtx->lockState()->isRSTLLocked());
}
/**
* Logs the index build failure error in a standard format.
*/
void logFailure(Status status,
const NamespaceString& nss,
std::shared_ptr<ReplIndexBuildState> replState) {
LOGV2(20649,
"Index build failed",
"buildUUID"_attr = replState->buildUUID,
"namespace"_attr = nss,
"uuid"_attr = replState->collectionUUID,
"error"_attr = status);
}
/**
* Iterates over index builds with the provided function.
*/
void forEachIndexBuild(
const std::vector<std::shared_ptr<ReplIndexBuildState>>& indexBuilds,
StringData context,
std::function<void(std::shared_ptr<ReplIndexBuildState> replState)> onIndexBuild) {
if (indexBuilds.empty()) {
return;
}
auto indexBuildLogger = [](const auto& indexBuild) {
BSONObjBuilder builder;
builder.append("buildUUID"_sd, indexBuild->buildUUID.toBSON());
builder.append("collectionUUID"_sd, indexBuild->collectionUUID.toBSON());
BSONArrayBuilder names;
for (const auto& indexName : indexBuild->indexNames) {
names.append(indexName);
}
builder.append("indexNames"_sd, names.arr());
builder.append("protocol"_sd,
indexBuild->protocol == IndexBuildProtocol::kTwoPhase ? "two phase"_sd
: "single phase"_sd);
return builder.obj();
};
auto begin = boost::make_transform_iterator(indexBuilds.begin(), indexBuildLogger);
auto end = boost::make_transform_iterator(indexBuilds.end(), indexBuildLogger);
LOGV2(20650,
"Active index builds",
"context"_attr = context,
"builds"_attr = logv2::seqLog(begin, end));
if (onIndexBuild) {
for (const auto& indexBuild : indexBuilds) {
onIndexBuild(indexBuild);
}
}
}
/**
* Updates currentOp for commitIndexBuild or abortIndexBuild.
*/
void updateCurOpForCommitOrAbort(OperationContext* opCtx, StringData fieldName, UUID buildUUID) {
BSONObjBuilder builder;
buildUUID.appendToBuilder(&builder, fieldName);
stdx::unique_lock<Client> lk(*opCtx->getClient());
auto curOp = CurOp::get(opCtx);
builder.appendElementsUnique(curOp->opDescription());
auto opDescObj = builder.obj();
curOp->setLogicalOp_inlock(LogicalOp::opCommand);
curOp->setOpDescription_inlock(opDescObj);
curOp->ensureStarted();
}
} // namespace
const auto getIndexBuildsCoord =
ServiceContext::declareDecoration<std::unique_ptr<IndexBuildsCoordinator>>();
void IndexBuildsCoordinator::set(ServiceContext* serviceContext,
std::unique_ptr<IndexBuildsCoordinator> ibc) {
auto& indexBuildsCoordinator = getIndexBuildsCoord(serviceContext);
invariant(!indexBuildsCoordinator);
indexBuildsCoordinator = std::move(ibc);
}
IndexBuildsCoordinator* IndexBuildsCoordinator::get(ServiceContext* serviceContext) {
auto& indexBuildsCoordinator = getIndexBuildsCoord(serviceContext);
invariant(indexBuildsCoordinator);
return indexBuildsCoordinator.get();
}
IndexBuildsCoordinator* IndexBuildsCoordinator::get(OperationContext* OperationContext) {
return get(OperationContext->getServiceContext());
}
IndexBuildsCoordinator::~IndexBuildsCoordinator() {
invariant(_allIndexBuilds.empty());
}
std::vector<std::string> IndexBuildsCoordinator::extractIndexNames(
const std::vector<BSONObj>& specs) {
std::vector<std::string> indexNames;
for (const auto& spec : specs) {
std::string name = spec.getStringField(IndexDescriptor::kIndexNameFieldName);
invariant(!name.empty(),
str::stream() << "Bad spec passed into ReplIndexBuildState constructor, missing '"
<< IndexDescriptor::kIndexNameFieldName << "' field: " << spec);
indexNames.push_back(name);
}
return indexNames;
}
StatusWith<std::pair<long long, long long>> IndexBuildsCoordinator::rebuildIndexesForRecovery(
OperationContext* opCtx,
const NamespaceString& nss,
const std::vector<BSONObj>& specs,
const UUID& buildUUID,
RepairData repair) {
const auto protocol = IndexBuildProtocol::kSinglePhase;
auto status = _startIndexBuildForRecovery(opCtx, nss, specs, buildUUID, protocol);
if (!status.isOK()) {
return status;
}
auto& collectionCatalog = CollectionCatalog::get(getGlobalServiceContext());
Collection* collection = collectionCatalog.lookupCollectionByNamespace(opCtx, nss);
// Complete the index build.
return _runIndexRebuildForRecovery(opCtx, collection, buildUUID, repair);
}
Status IndexBuildsCoordinator::_startIndexBuildForRecovery(OperationContext* opCtx,
const NamespaceString& nss,
const std::vector<BSONObj>& specs,
const UUID& buildUUID,
IndexBuildProtocol protocol) {
invariant(opCtx->lockState()->isCollectionLockedForMode(nss, MODE_X));
std::vector<std::string> indexNames;
for (auto& spec : specs) {
std::string name = spec.getStringField(IndexDescriptor::kIndexNameFieldName);
if (name.empty()) {
return Status(ErrorCodes::CannotCreateIndex,
str::stream()
<< "Cannot create an index for a spec '" << spec
<< "' without a non-empty string value for the 'name' field");
}
indexNames.push_back(name);
}
auto& collectionCatalog = CollectionCatalog::get(getGlobalServiceContext());
Collection* collection = collectionCatalog.lookupCollectionByNamespace(opCtx, nss);
auto indexCatalog = collection->getIndexCatalog();
{
// These steps are combined into a single WUOW to ensure there are no commits without
// the indexes.
// 1) Drop all unfinished indexes.
// 2) Start, but do not complete the index build process.
WriteUnitOfWork wuow(opCtx);
for (size_t i = 0; i < indexNames.size(); i++) {
bool includeUnfinished = false;
auto descriptor =
indexCatalog->findIndexByName(opCtx, indexNames[i], includeUnfinished);
if (descriptor) {
Status s = indexCatalog->dropIndex(opCtx, descriptor);
if (!s.isOK()) {
return s;
}
continue;
}
// If the index is not present in the catalog, then we are trying to drop an already
// aborted index. This may happen when rollback-via-refetch restarts an index build
// after an abort has been rolled back.
if (!DurableCatalog::get(opCtx)->isIndexPresent(
opCtx, collection->getCatalogId(), indexNames[i])) {
LOGV2(20652,
"The index for build {buildUUID} was not found while trying to drop the "
"index during recovery: {index}",
"An index was not found in the catalog while trying to drop the index during "
"recovery",
"buildUUID"_attr = buildUUID,
"index"_attr = indexNames[i]);
continue;
}
const auto durableBuildUUID = DurableCatalog::get(opCtx)->getIndexBuildUUID(
opCtx, collection->getCatalogId(), indexNames[i]);
// A build UUID is present if and only if we are rebuilding a two-phase build.
invariant((protocol == IndexBuildProtocol::kTwoPhase) ==
durableBuildUUID.is_initialized());
// When a buildUUID is present, it must match the build UUID parameter to this
// function.
invariant(!durableBuildUUID || *durableBuildUUID == buildUUID,
str::stream() << "durable build UUID: " << durableBuildUUID
<< "buildUUID: " << buildUUID);
// If the unfinished index is in the IndexCatalog, drop it through there, otherwise drop
// it from the DurableCatalog. Rollback-via-refetch does not clear any in-memory state,
// so we should do it manually here.
includeUnfinished = true;
descriptor = indexCatalog->findIndexByName(opCtx, indexNames[i], includeUnfinished);
if (descriptor) {
Status s = indexCatalog->dropUnfinishedIndex(opCtx, descriptor);
if (!s.isOK()) {
return s;
}
} else {
Status status = DurableCatalog::get(opCtx)->removeIndex(
opCtx, collection->getCatalogId(), indexNames[i]);
if (!status.isOK()) {
return status;
}
}
}
// We need to initialize the collection to rebuild the indexes. The collection may already
// be initialized when rebuilding indexes with rollback-via-refetch.
if (!collection->isInitialized()) {
collection->init(opCtx);
}
auto dbName = nss.db().toString();
auto replIndexBuildState = std::make_shared<ReplIndexBuildState>(
buildUUID, collection->uuid(), dbName, specs, protocol);
Status status = [&]() {
stdx::unique_lock<Latch> lk(_mutex);
return _registerIndexBuild(lk, replIndexBuildState);
}();
if (!status.isOK()) {
return status;
}
IndexBuildsManager::SetupOptions options;
options.protocol = protocol;
status = _indexBuildsManager.setUpIndexBuild(
opCtx, collection, specs, buildUUID, MultiIndexBlock::kNoopOnInitFn, options);
if (!status.isOK()) {
// An index build failure during recovery is fatal.
logFailure(status, nss, replIndexBuildState);
fassertNoTrace(51086, status);
}
wuow.commit();
}
return Status::OK();
}
std::string IndexBuildsCoordinator::_indexBuildActionToString(IndexBuildAction action) {
if (action == IndexBuildAction::kNoAction) {
return "No action";
} else if (action == IndexBuildAction::kOplogCommit) {
return "Oplog commit";
} else if (action == IndexBuildAction::kOplogAbort) {
return "Oplog abort";
} else if (action == IndexBuildAction::kInitialSyncAbort) {
return "Initial sync abort";
} else if (action == IndexBuildAction::kRollbackAbort) {
return "Rollback abort";
} else if (action == IndexBuildAction::kPrimaryAbort) {
return "Primary abort";
} else if (action == IndexBuildAction::kSinglePhaseCommit) {
return "Single-phase commit";
} else if (action == IndexBuildAction::kCommitQuorumSatisfied) {
return "Commit quorum Satisfied";
}
MONGO_UNREACHABLE;
}
void IndexBuildsCoordinator::waitForAllIndexBuildsToStopForShutdown(OperationContext* opCtx) {
stdx::unique_lock<Latch> lk(_mutex);
// All index builds should have been signaled to stop via the ServiceContext.
if (_allIndexBuilds.empty()) {
return;
}
auto indexBuildToUUID = [](const auto& indexBuild) { return indexBuild.first; };
auto begin = boost::make_transform_iterator(_allIndexBuilds.begin(), indexBuildToUUID);
auto end = boost::make_transform_iterator(_allIndexBuilds.end(), indexBuildToUUID);
LOGV2(4725201,
"Waiting until the following index builds are finished",
"indexBuilds"_attr = logv2::seqLog(begin, end));
// Wait for all the index builds to stop.
auto pred = [this]() { return _allIndexBuilds.empty(); };
_indexBuildsCondVar.wait(lk, pred);
}
std::vector<UUID> IndexBuildsCoordinator::abortCollectionIndexBuilds(
OperationContext* opCtx,
const NamespaceString collectionNss,
const UUID collectionUUID,
const std::string& reason) {
LOGV2(23879,
"About to abort all index builders",
"namespace"_attr = collectionNss,
"uuid"_attr = collectionUUID,
"reason"_attr = reason);
auto collIndexBuilds = [&]() -> std::vector<std::shared_ptr<ReplIndexBuildState>> {
stdx::unique_lock<Latch> lk(_mutex);
auto indexBuildFilter = [=](const auto& replState) {
return collectionUUID == replState.collectionUUID;
};
return _filterIndexBuilds_inlock(lk, indexBuildFilter);
}();
std::vector<UUID> buildUUIDs;
for (auto replState : collIndexBuilds) {
if (abortIndexBuildByBuildUUID(
opCtx, replState->buildUUID, IndexBuildAction::kPrimaryAbort, reason)) {
buildUUIDs.push_back(replState->buildUUID);
}
}
return buildUUIDs;
}
void IndexBuildsCoordinator::_awaitNoBgOpInProgForDb(stdx::unique_lock<Latch>& lk,
OperationContext* opCtx,
StringData db) {
auto indexBuildFilter = [db](const auto& replState) { return db == replState.dbName; };
auto pred = [&, this]() {
auto dbIndexBuilds = _filterIndexBuilds_inlock(lk, indexBuildFilter);
return dbIndexBuilds.empty();
};
_indexBuildsCondVar.wait(lk, pred);
}
void IndexBuildsCoordinator::abortDatabaseIndexBuilds(OperationContext* opCtx,
StringData db,
const std::string& reason) {
LOGV2(4612302,
"About to abort all index builders running for collections in the given database",
"database"_attr = db,
"reason"_attr = reason);
auto builds = [&]() -> std::vector<std::shared_ptr<ReplIndexBuildState>> {
stdx::unique_lock<Latch> lk(_mutex);
auto indexBuildFilter = [=](const auto& replState) { return db == replState.dbName; };
return _filterIndexBuilds_inlock(lk, indexBuildFilter);
}();
for (auto replState : builds) {
abortIndexBuildByBuildUUID(
opCtx, replState->buildUUID, IndexBuildAction::kPrimaryAbort, reason);
}
}
void IndexBuildsCoordinator::abortAllIndexBuildsForInitialSync(OperationContext* opCtx,
const std::string& reason) {
LOGV2(4833200, "About to abort all index builders running", "reason"_attr = reason);
auto builds = [&]() -> std::vector<std::shared_ptr<ReplIndexBuildState>> {
stdx::unique_lock<Latch> lk(_mutex);
auto indexBuildFilter = [](const auto& replState) { return true; };
return _filterIndexBuilds_inlock(lk, indexBuildFilter);
}();
for (auto replState : builds) {
abortIndexBuildByBuildUUID(
opCtx, replState->buildUUID, IndexBuildAction::kInitialSyncAbort, reason);
}
}
namespace {
NamespaceString getNsFromUUID(OperationContext* opCtx, const UUID& uuid) {
auto& catalog = CollectionCatalog::get(opCtx);
auto nss = catalog.lookupNSSByUUID(opCtx, uuid);
uassert(ErrorCodes::NamespaceNotFound, "No namespace with UUID " + uuid.toString(), nss);
return *nss;
}
} // namespace
void IndexBuildsCoordinator::applyStartIndexBuild(OperationContext* opCtx,
ApplicationMode applicationMode,
const IndexBuildOplogEntry& oplogEntry) {
const auto collUUID = oplogEntry.collUUID;
const auto nss = getNsFromUUID(opCtx, collUUID);
IndexBuildsCoordinator::IndexBuildOptions indexBuildOptions;
indexBuildOptions.replSetAndNotPrimaryAtStart = true;
indexBuildOptions.applicationMode = applicationMode;
// If this is an initial syncing node, drop any conflicting ready index specs prior to
// proceeding with building them.
if (indexBuildOptions.applicationMode == ApplicationMode::kInitialSync) {
auto dbAndUUID = NamespaceStringOrUUID(nss.db().toString(), collUUID);
writeConflictRetry(opCtx, "IndexBuildsCoordinator::applyStartIndexBuild", nss.ns(), [&] {
WriteUnitOfWork wuow(opCtx);
AutoGetCollection autoColl(opCtx, dbAndUUID, MODE_X);
auto coll = autoColl.getCollection();
invariant(coll,
str::stream() << "Collection with UUID " << collUUID << " was dropped.");
IndexCatalog* indexCatalog = coll->getIndexCatalog();
const bool includeUnfinished = false;
for (const auto& spec : oplogEntry.indexSpecs) {
std::string name = spec.getStringField(IndexDescriptor::kIndexNameFieldName);
uassert(ErrorCodes::BadValue,
str::stream() << "Index spec is missing the 'name' field " << spec,
!name.empty());
if (auto desc = indexCatalog->findIndexByName(opCtx, name, includeUnfinished)) {
uassertStatusOK(indexCatalog->dropIndex(opCtx, desc));
}
}
wuow.commit();
});
}
auto indexBuildsCoord = IndexBuildsCoordinator::get(opCtx);
uassertStatusOK(
indexBuildsCoord
->startIndexBuild(opCtx,
nss.db().toString(),
collUUID,
oplogEntry.indexSpecs,
oplogEntry.buildUUID,
/* This oplog entry is only replicated for two-phase index builds */
IndexBuildProtocol::kTwoPhase,
indexBuildOptions)
.getStatus());
}
void IndexBuildsCoordinator::applyCommitIndexBuild(OperationContext* opCtx,
const IndexBuildOplogEntry& oplogEntry) {
const auto collUUID = oplogEntry.collUUID;
const auto nss = getNsFromUUID(opCtx, collUUID);
const auto& buildUUID = oplogEntry.buildUUID;
updateCurOpForCommitOrAbort(opCtx, kCommitIndexBuildFieldName, buildUUID);
uassert(31417,
str::stream()
<< "No commit timestamp set while applying commitIndexBuild operation. Build UUID: "
<< buildUUID,
!opCtx->recoveryUnit()->getCommitTimestamp().isNull());
// There is a possibility that we cannot find an active index build with the given build UUID.
// This can be the case when the index already exists or was dropped on the sync source before
// the collection was cloned during initial sync. The oplog code will ignore the NoSuchKey
// error code.
//
// Case 1: Index already exists:
// +-----------------------------------------+--------------------------------+
// | Sync Target | Sync Source |
// +-----------------------------------------+--------------------------------+
// | | startIndexBuild 'x' at TS: 1. |
// | Start oplog fetcher at TS: 2. | |
// | | commitIndexBuild 'x' at TS: 2. |
// | Begin cloning the collection. | |
// | Index 'x' is listed as ready, build it. | |
// | Finish cloning the collection. | |
// | Start the oplog replay phase. | |
// | Apply commitIndexBuild 'x'. | |
// | --- Index build not found --- | |
// +-----------------------------------------+--------------------------------+
//
// Case 2: Sync source dropped the index:
// +--------------------------------+--------------------------------+
// | Sync Target | Sync Source |
// +--------------------------------+--------------------------------+
// | | startIndexBuild 'x' at TS: 1. |
// | Start oplog fetcher at TS: 2. | |
// | | commitIndexBuild 'x' at TS: 2. |
// | | dropIndex 'x' at TS: 3. |
// | Begin cloning the collection. | |
// | No user indexes to build. | |
// | Finish cloning the collection. | |
// | Start the oplog replay phase. | |
// | Apply commitIndexBuild 'x'. | |
// | --- Index build not found --- | |
// +--------------------------------+--------------------------------+
auto replState = uassertStatusOK(_getIndexBuild(buildUUID));
// Retry until we are able to put the index build in the kPrepareCommit state. None of the
// conditions for retrying are common or expected to be long-lived, so we believe this to be
// safe to poll at this frequency.
while (!_tryCommit(opCtx, replState)) {
opCtx->sleepFor(Milliseconds(100));
}
auto fut = replState->sharedPromise.getFuture();
LOGV2(20654,
"Index build joined after commit",
"buildUUID"_attr = buildUUID,
"result"_attr = fut.waitNoThrow(opCtx));
// Throws if there was an error building the index.
fut.get();
}
bool IndexBuildsCoordinator::_tryCommit(OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState) {
stdx::unique_lock<Latch> lk(replState->mutex);
if (replState->indexBuildState.isSettingUp()) {
// It's possible that the index build thread has not reached the point where it can be
// committed yet.
return false;
}
if (replState->waitForNextAction->getFuture().isReady()) {
// If the future wait were uninterruptible, then shutdown could hang. If the
// IndexBuildsCoordinator thread gets interrupted on shutdown, the oplog applier will hang
// waiting for the promise applying the commitIndexBuild oplog entry.
const auto nextAction = replState->waitForNextAction->getFuture().get(opCtx);
invariant(nextAction == IndexBuildAction::kCommitQuorumSatisfied);
// Retry until the current promise result is consumed by the index builder thread and
// a new empty promise got created by the indexBuildscoordinator thread.
return false;
}
auto skipCheck = shouldSkipIndexBuildStateTransitionCheck(opCtx, replState->protocol);
replState->indexBuildState.setState(
IndexBuildState::kPrepareCommit, skipCheck, opCtx->recoveryUnit()->getCommitTimestamp());
// Promise can be set only once.
// We can't skip signaling here if a signal is already set because the previous commit or
// abort signal might have been sent to handle for primary case.
setSignalAndCancelVoteRequestCbkIfActive(lk, opCtx, replState, IndexBuildAction::kOplogCommit);
return true;
}
void IndexBuildsCoordinator::applyAbortIndexBuild(OperationContext* opCtx,
const IndexBuildOplogEntry& oplogEntry) {
const auto collUUID = oplogEntry.collUUID;
const auto nss = getNsFromUUID(opCtx, collUUID);
const auto& buildUUID = oplogEntry.buildUUID;
updateCurOpForCommitOrAbort(opCtx, kCommitIndexBuildFieldName, buildUUID);
invariant(oplogEntry.cause);
uassert(31420,
str::stream()
<< "No commit timestamp set while applying abortIndexBuild operation. Build UUID: "
<< buildUUID,
!opCtx->recoveryUnit()->getCommitTimestamp().isNull());
std::string abortReason(str::stream()
<< "abortIndexBuild oplog entry encountered: " << *oplogEntry.cause);
auto indexBuildsCoord = IndexBuildsCoordinator::get(opCtx);
indexBuildsCoord->abortIndexBuildByBuildUUID(
opCtx, buildUUID, IndexBuildAction::kOplogAbort, abortReason);
}
boost::optional<UUID> IndexBuildsCoordinator::abortIndexBuildByIndexNames(
OperationContext* opCtx,
const UUID& collectionUUID,
const std::vector<std::string>& indexNames,
std::string reason) {
boost::optional<UUID> buildUUID;
auto indexBuilds = _getIndexBuilds();
auto onIndexBuild = [&](const std::shared_ptr<ReplIndexBuildState>& replState) {
if (replState->collectionUUID != collectionUUID) {
return;
}
bool matchedBuilder = std::is_permutation(indexNames.begin(),
indexNames.end(),
replState->indexNames.begin(),
replState->indexNames.end());
if (!matchedBuilder) {
return;
}
LOGV2(23880,
"About to abort index builder: {buildUUID} on collection: "
"{collectionUUID}. First index: {firstIndex}",
"About to abort index builder",
"buildUUID"_attr = replState->buildUUID,
"collectionUUID"_attr = collectionUUID,
"firstIndex"_attr = replState->indexNames.front());
if (abortIndexBuildByBuildUUID(
opCtx, replState->buildUUID, IndexBuildAction::kPrimaryAbort, reason)) {
buildUUID = replState->buildUUID;
}
};
forEachIndexBuild(
indexBuilds, "IndexBuildsCoordinator::abortIndexBuildByIndexNames"_sd, onIndexBuild);
return buildUUID;
}
bool IndexBuildsCoordinator::hasIndexBuilder(OperationContext* opCtx,
const UUID& collectionUUID,
const std::vector<std::string>& indexNames) const {
bool foundIndexBuilder = false;
boost::optional<UUID> buildUUID;
auto indexBuilds = _getIndexBuilds();
auto onIndexBuild = [&](const std::shared_ptr<ReplIndexBuildState>& replState) {
if (replState->collectionUUID != collectionUUID) {
return;
}
bool matchedBuilder = std::is_permutation(indexNames.begin(),
indexNames.end(),
replState->indexNames.begin(),
replState->indexNames.end());
if (!matchedBuilder) {
return;
}
foundIndexBuilder = true;
};
forEachIndexBuild(indexBuilds, "IndexBuildsCoordinator::hasIndexBuilder"_sd, onIndexBuild);
return foundIndexBuilder;
}
IndexBuildsCoordinator::TryAbortResult IndexBuildsCoordinator::_tryAbort(
OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState,
IndexBuildAction signalAction,
std::string reason) {
{
stdx::unique_lock<Latch> lk(replState->mutex);
// Wait until the build is done setting up. This indicates that all required state is
// initialized to attempt an abort.
if (replState->indexBuildState.isSettingUp()) {
LOGV2_DEBUG(465605,
2,
"waiting until index build is done setting up before attempting to abort",
"buildUUID"_attr = replState->buildUUID);
return TryAbortResult::kRetry;
}
if (replState->waitForNextAction->getFuture().isReady()) {
const auto nextAction = replState->waitForNextAction->getFuture().get(opCtx);
invariant(nextAction == IndexBuildAction::kSinglePhaseCommit ||
nextAction == IndexBuildAction::kCommitQuorumSatisfied ||
nextAction == IndexBuildAction::kPrimaryAbort);
// Index build coordinator already received a signal to commit or abort. So, it's ok
// to return and wait for the index build to complete if we are trying to signal
// 'kPrimaryAbort'. The index build coordinator will not perform the signaled action
// (i.e, will not commit or abort the index build) only when the node steps down.
// When the node steps down, the caller of this function, dropIndexes/createIndexes
// command (user operation) will also get interrupted. So, we no longer need to
// abort the index build on step down.
if (signalAction == IndexBuildAction::kPrimaryAbort) {
// Indicate if the index build is already being committed or aborted.
if (nextAction == IndexBuildAction::kPrimaryAbort) {
return TryAbortResult::kAlreadyAborted;
} else {
return TryAbortResult::kNotAborted;
}
}
// Retry until the current promise result is consumed by the index builder thread
// and a new empty promise got created by the indexBuildscoordinator thread. Or,
// until the index build got torn down after index build commit.
return TryAbortResult::kRetry;
}
LOGV2(4656003,
"Aborting index build",
"buildUUID"_attr = replState->buildUUID,
"error"_attr = reason);
// Set the state on replState. Once set, the calling thread must complete the abort process.
auto abortTimestamp =
boost::make_optional<Timestamp>(!opCtx->recoveryUnit()->getCommitTimestamp().isNull(),
opCtx->recoveryUnit()->getCommitTimestamp());
auto skipCheck = shouldSkipIndexBuildStateTransitionCheck(opCtx, replState->protocol);
replState->indexBuildState.setState(
IndexBuildState::kAborted, skipCheck, abortTimestamp, reason);
// Interrupt the builder thread so that it can no longer acquire locks or make progress.
// It is possible that the index build thread may have completed its operation and removed
// itself from the ServiceContext. This may happen in the case of an explicit db.killOp()
// operation or during shutdown.
// During normal operation, the abort logic, initiated through external means such as
// dropIndexes or internally through an indexing error, should have set the state in
// ReplIndexBuildState so that this code would not be reachable as it is no longer necessary
// to interrupt the builder thread here.
auto serviceContext = opCtx->getServiceContext();
if (auto target = serviceContext->getLockedClient(replState->opId)) {
auto targetOpCtx = target->getOperationContext();
serviceContext->killOperation(target, targetOpCtx, ErrorCodes::IndexBuildAborted);
}
// Set the signal. Because we have already interrupted the index build, it will not observe
// this signal. We do this so that other observers do not also try to abort the index build.
setSignalAndCancelVoteRequestCbkIfActive(lk, opCtx, replState, signalAction);
}
return TryAbortResult::kContinueAbort;
}
bool IndexBuildsCoordinator::abortIndexBuildByBuildUUID(OperationContext* opCtx,
const UUID& buildUUID,
IndexBuildAction signalAction,
std::string reason) {
std::shared_ptr<ReplIndexBuildState> replState;
bool retry = false;
while (true) {
// Retry until we are able to put the index build into the kAborted state. None of the
// conditions for retrying are common or expected to be long-lived, so we believe this to be
// safe to poll at this frequency.
if (retry) {
opCtx->sleepFor(Milliseconds(1000));
retry = false;
}
// It is possible to receive an abort for a non-existent index build. Abort should always
// succeed, so suppress the error.
auto replStateResult = _getIndexBuild(buildUUID);
if (!replStateResult.isOK()) {
LOGV2(20656,
"ignoring error while aborting index build {buildUUID}: {error}",
"Ignoring error while aborting index build",
"buildUUID"_attr = buildUUID,
"error"_attr = replStateResult.getStatus());
return false;
}
replState = replStateResult.getValue();
LOGV2(4656010, "Attempting to abort index build", "buildUUID"_attr = replState->buildUUID);
const NamespaceStringOrUUID dbAndUUID(replState->dbName, replState->collectionUUID);
Lock::DBLock dbLock(opCtx, replState->dbName, MODE_IX);
if (IndexBuildProtocol::kSinglePhase == replState->protocol) {
// Unlock RSTL to avoid deadlocks with prepare conflicts and state transitions caused by
// taking a strong collection lock. See SERVER-42621.
unlockRSTL(opCtx);