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
|
/**
* 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 <algorithm>
#include <list>
#include <string>
#include <vector>
#include "mongo/bson/bsonobj.h"
#include "mongo/db/catalog/commit_quorum_options.h"
#include "mongo/db/index/index_descriptor.h"
#include "mongo/db/namespace_string.h"
#include "mongo/stdx/condition_variable.h"
#include "mongo/util/future.h"
#include "mongo/util/net/hostandport.h"
#include "mongo/util/uuid.h"
namespace mongo {
// Indicates which protocol an index build is using.
enum class IndexBuildProtocol {
/**
* Refers to the pre-FCV 4.2 index build protocol for building indexes in replica sets.
* Index builds must complete on the primary before replicating, and are not resumable in
* any scenario.
*/
kSinglePhase,
/**
* Refers to the FCV 4.2 two-phase index build protocol for building indexes in replica
* sets. Indexes are built simultaneously on all nodes and are resumable during the draining
* phase.
*/
kTwoPhase
};
/**
* Tracks the cross replica set progress of a particular index build identified by a build UUID.
*
* This is intended to only be used by the IndexBuildsCoordinator class.
*
* TODO: pass in commit quorum setting.
*/
struct ReplIndexBuildState {
ReplIndexBuildState(const UUID& indexBuildUUID,
const UUID& collUUID,
const std::string& dbName,
const std::vector<BSONObj>& specs,
IndexBuildProtocol protocol,
boost::optional<CommitQuorumOptions> commitQuorum)
: buildUUID(indexBuildUUID),
collectionUUID(collUUID),
dbName(dbName),
indexNames(extractIndexNames(specs)),
indexSpecs(specs),
protocol(protocol),
commitQuorum(commitQuorum) {}
// Uniquely identifies this index build across replica set members.
const UUID buildUUID;
// Identifies the collection for which the index is being built. Collections can be renamed, so
// the collection UUID is used to maintain correct association.
const UUID collectionUUID;
// Identifies the database containing the index being built. Unlike collections, databases
// cannot be renamed.
const std::string dbName;
// The names of the indexes being built.
const std::vector<std::string> indexNames;
// The specs of the index(es) being built. Facilitates new callers joining an active index
// build.
const std::vector<BSONObj> indexSpecs;
// Whether to do a two phase index build or a single phase index build like in v4.0. The FCV
// at the start of the index build will determine this setting.
IndexBuildProtocol protocol;
// Protects the state below.
mutable stdx::mutex mutex;
// Secondaries do not set this information, so it is only set on primaries or on
// transition to primary.
boost::optional<CommitQuorumOptions> commitQuorum;
// Tracks the members of the replica set that have finished building the index(es) and are ready
// to commit the index(es).
std::vector<HostAndPort> commitReadyMembers;
using IndexCatalogStats = struct {
int numIndexesBefore = 0;
int numIndexesAfter = 0;
};
// Tracks the index build stats that are returned to the caller upon success.
IndexCatalogStats stats;
// Communicates the final outcome of the index build to any callers waiting upon the associated
// SharedSemiFuture(s).
SharedPromise<IndexCatalogStats> sharedPromise;
// There is a period of time where the index build is registered on the coordinator, but an
// index builder does not yet exist. Since a signal cannot be set on the index builder at that
// time, it must be saved here.
bool aborted = false;
std::string abortReason = "";
// The coordinator for the index build will wait upon this when awaiting an external signal,
// such as commit or commit readiness signals.
stdx::condition_variable condVar;
private:
std::vector<std::string> 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;
}
};
} // namespace mongo
|
