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
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include "mongo/db/index_builds_coordinator.h"
#include "mongo/util/concurrency/thread_pool.h"
namespace mongo {
class OperationContext;
class ServiceContext;
/**
* This implementation of the IndexBuildsCoordinator is for replica set member and standalone nodes.
* It has a thread pool that runs index builds asynchronously, returning results via the base class'
* established Futures and Promises protocol. Replica set member state is tracked and affects how
* index builds are run: their role in the cross replica set index builds.
*
* The IndexBuildsCoordinator is instantiated on the ServiceContext as a decoration, and is
* accessible via the ServiceContext.
*/
class IndexBuildsCoordinatorMongod : public IndexBuildsCoordinator {
IndexBuildsCoordinatorMongod(const IndexBuildsCoordinatorMongod&) = delete;
IndexBuildsCoordinatorMongod& operator=(const IndexBuildsCoordinatorMongod&) = delete;
public:
/**
* Sets up the thread pool.
*/
IndexBuildsCoordinatorMongod();
/**
* Shuts down the thread pool, signals interrupt to all index builds, then waits for all of the
* threads to finish.
*/
void shutdown(OperationContext* opCtx) override;
/**
* Sets up the in-memory and persisted state of the index build, then passes the build off to an
* asynchronous thread to run. A Future is returned so that the user can await the asynchronous
* build result.
*
* Returns an error status if there are any errors setting up the index build.
*/
StatusWith<SharedSemiFuture<ReplIndexBuildState::IndexCatalogStats>> startIndexBuild(
OperationContext* opCtx,
const DatabaseName& dbName,
const UUID& collectionUUID,
const std::vector<BSONObj>& specs,
const UUID& buildUUID,
IndexBuildProtocol protocol,
IndexBuildOptions indexBuildOptions) override;
/**
* Reconstructs the in-memory state of the index build, then passes the build off to an
* asynchronous thread to run. A Future is returned so that the user can await the asynchronous
* build result.
*/
StatusWith<SharedSemiFuture<ReplIndexBuildState::IndexCatalogStats>> resumeIndexBuild(
OperationContext* opCtx,
const DatabaseName& dbName,
const UUID& collectionUUID,
const std::vector<BSONObj>& specs,
const UUID& buildUUID,
const ResumeIndexInfo& resumeInfo) override;
Status voteAbortIndexBuild(OperationContext* opCtx,
const UUID& buildUUID,
const HostAndPort& hostAndPort,
const StringData& reason) override;
Status voteCommitIndexBuild(OperationContext* opCtx,
const UUID& buildUUID,
const HostAndPort& hostAndPort) override;
Status setCommitQuorum(OperationContext* opCtx,
const NamespaceString& nss,
const std::vector<StringData>& indexNames,
const CommitQuorumOptions& newCommitQuorum) override;
private:
/**
* Keeps track of the relevant replica set member states. Index builds are managed differently
* depending on the state of the replica set member.
*
* These states follow the replica set member states, as maintained by MemberState in the
* ReplicationCoordinator. If not in Primary or InitialSync modes, then the default will be
* Secondary, with the expectation that a replica set member must always transition to Secondary
* before Primary.
*/
enum class ReplState { Primary, Secondary, InitialSync };
/**
* TODO: not yet implemented.
*/
Status _finishScanningPhase();
/**
* TODO: not yet implemented.
*/
Status _finishVerificationPhase();
/**
* TODO: not yet implemented.
*/
Status _finishCommitPhase();
/**
* TODO: not yet implemented.
*/
StatusWith<bool> _checkCommitQuorum(const BSONObj& commitQuorum,
const std::vector<HostAndPort>& confirmedMembers);
/**
* TODO: not yet implemented.
*/
void _refreshReplStateFromPersisted(OperationContext* opCtx, const UUID& buildUUID);
/**
* Signals index builder to commit.
*/
void _sendCommitQuorumSatisfiedSignal(OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState);
bool _signalIfCommitQuorumIsSatisfied(OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState) override;
bool _signalIfCommitQuorumNotEnabled(OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState) override;
void _signalPrimaryForAbortAndWaitForExternalAbort(OperationContext* opCtx,
ReplIndexBuildState* replState,
const Status& abortStatus) override;
void _signalPrimaryForCommitReadiness(OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState) override;
IndexBuildAction _drainSideWritesUntilNextActionIsAvailable(
OperationContext* opCtx, std::shared_ptr<ReplIndexBuildState> replState) override;
void _waitForNextIndexBuildActionAndCommit(OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState,
const IndexBuildOptions& indexBuildOptions) override;
StatusWith<SharedSemiFuture<ReplIndexBuildState::IndexCatalogStats>> _startIndexBuild(
OperationContext* opCtx,
const DatabaseName& dbName,
const UUID& collectionUUID,
const std::vector<BSONObj>& specs,
const UUID& buildUUID,
IndexBuildProtocol protocol,
IndexBuildOptions indexBuildOptions,
const boost::optional<ResumeIndexInfo>& resumeInfo);
// Thread pool on which index builds are run.
ThreadPool _threadPool;
// Manages _numActiveIndexBuilds and _indexBuildFinished.
mutable Mutex _throttlingMutex =
MONGO_MAKE_LATCH("IndexBuildsCoordinatorMongod::_throttlingMutex");
// Protected by _mutex.
int _numActiveIndexBuilds = 0;
// Condition signalled to indicate that an index build thread finished executing.
stdx::condition_variable _indexBuildFinished;
};
} // namespace mongo
|
