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
|
/**
* 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 <functional>
#include <map>
#include <string>
#include <vector>
#include "mongo/db/catalog/multi_index_block.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/rebuild_indexes.h"
#include "mongo/db/repl_index_build_state.h"
#include "mongo/platform/mutex.h"
namespace mongo {
class Collection;
class OperationContext;
class ServiceContext;
enum IndexBuildRecoveryState { Building, Verifying, Committing };
/**
* This is the interface through which to act on index builders. Index builder life times are
* managed here, and all actions taken on index builders pass through this interface. Index builder
* state is set up and then cleaned up by this class.
*/
class IndexBuildsManager {
IndexBuildsManager(const IndexBuildsManager&) = delete;
IndexBuildsManager& operator=(const IndexBuildsManager&) = delete;
public:
/**
* Indicates whether or not to ignore indexing constraints.
*/
enum class IndexConstraints { kEnforce, kRelax };
/**
* Additional options for setUpIndexBuild. The default values are sufficient in most cases.
*/
struct SetupOptions {
SetupOptions();
IndexConstraints indexConstraints = IndexConstraints::kEnforce;
IndexBuildProtocol protocol = IndexBuildProtocol::kSinglePhase;
};
IndexBuildsManager() = default;
~IndexBuildsManager();
/**
* Sets up the index build state and registers it in the manager.
*/
using OnInitFn = MultiIndexBlock::OnInitFn;
Status setUpIndexBuild(OperationContext* opCtx,
Collection* collection,
const std::vector<BSONObj>& specs,
const UUID& buildUUID,
OnInitFn onInit,
SetupOptions options = {},
const boost::optional<ResumeIndexInfo>& resumeInfo = boost::none);
/**
* Unregisters the builder associated with the given buildUUID from the _builders map.
*/
void unregisterIndexBuild(const UUID& buildUUID);
/**
* Runs the scanning/insertion phase of the index build..
*/
Status startBuildingIndex(OperationContext* opCtx,
Collection* collection,
const UUID& buildUUID);
/**
* Iterates through every record in the collection to index it. May also remove documents
* that are not valid BSON objects, if repair is set to kYes.
*
* Returns the number of records and the size of the data iterated over.
*/
StatusWith<std::pair<long long, long long>> startBuildingIndexForRecovery(
OperationContext* opCtx, NamespaceString ns, const UUID& buildUUID, RepairData repair);
/**
* Document inserts observed during the scanning/insertion phase of an index build are not
* added but are instead stored in a temporary buffer until this function is invoked.
*/
Status drainBackgroundWrites(OperationContext* opCtx,
const UUID& buildUUID,
RecoveryUnit::ReadSource readSource,
IndexBuildInterceptor::DrainYieldPolicy drainYieldPolicy);
/**
* Retries the key generation and insertion of records that were skipped during the scanning
* phase due to error suppression.
*/
Status retrySkippedRecords(OperationContext* opCtx,
const UUID& buildUUID,
Collection* collection);
/**
* Runs the index constraint violation checking phase of the index build..
*/
Status checkIndexConstraintViolations(OperationContext* opCtx, const UUID& buildUUID);
/**
* Persists information in the index catalog entry that the index is ready for use, as well as
* updating the in-memory index catalog entry for this index to ready.
*/
using OnCreateEachFn = MultiIndexBlock::OnCreateEachFn;
using OnCommitFn = MultiIndexBlock::OnCommitFn;
Status commitIndexBuild(OperationContext* opCtx,
Collection* collection,
const NamespaceString& nss,
const UUID& buildUUID,
OnCreateEachFn onCreateEachFn,
OnCommitFn onCommitFn);
/**
* Deletes the index entry from the durable catalog.
*/
using OnCleanUpFn = MultiIndexBlock::OnCleanUpFn;
bool abortIndexBuild(OperationContext* opCtx,
Collection* collection,
const UUID& buildUUID,
OnCleanUpFn onCleanUpFn);
/**
* Signals the index build to be aborted without being cleaned up and returns without waiting
* for it to stop. Does nothing if the index build has already been cleared away.
*
* Returns true if a build existed to be signaled, as opposed to having already finished and
* been cleared away, or not having yet started..
*/
bool abortIndexBuildWithoutCleanupForRollback(OperationContext* opCtx,
Collection* collection,
const UUID& buildUUID);
/**
* The same as abortIndexBuildWithoutCleanupForRollback above, but additionally writes the
* current state of the index build to disk if the specified index build is a two-phase hybrid
* index build and resumable index builds are supported.
*/
bool abortIndexBuildWithoutCleanupForShutdown(OperationContext* opCtx,
Collection* collection,
const UUID& buildUUID);
/**
* Returns true if the index build supports background writes while building an index. This is
* true for the kHybrid method.
*/
bool isBackgroundBuilding(const UUID& buildUUID);
/**
* Checks via invariant that the manager has no index builds presently.
*/
void verifyNoIndexBuilds_forTestOnly();
private:
/**
* Creates and registers a new builder in the _builders map, mapped by the provided buildUUID.
*/
void _registerIndexBuild(UUID buildUUID);
/**
* Returns a pointer to the builder. Returns a bad status if the builder does not exist.
*/
StatusWith<MultiIndexBlock*> _getBuilder(const UUID& buildUUID);
// Protects the map data structures below.
mutable Mutex _mutex = MONGO_MAKE_LATCH("IndexBuildsManager::_mutex");
// Map of index builders by build UUID. Allows access to the builders so that actions can be
// taken on and information passed to and from index builds.
std::map<UUID, std::unique_ptr<MultiIndexBlock>> _builders;
/**
* Deletes record containing duplicate keys and insert it into a local lost and found collection
* titled "local.system.lost_and_found.<original collection UUID>". Returns the size of the
* record removed.
*/
StatusWith<int> _moveRecordToLostAndFound(OperationContext* opCtx,
NamespaceString ns,
NamespaceString lostAndFoundNss,
RecordId dupRecord);
};
} // namespace mongo
|
