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
|
/**
* Copyright (C) 2020-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 <map>
#include "mongo/db/catalog/index_builds_manager.h"
#include "mongo/db/repl_index_build_state.h"
#include "mongo/platform/mutex.h"
namespace mongo {
/**
* This is a helper class used by IndexBuildsCoordinator to safely manage the data structures
* that keep track of active index builds. It is owned by IndexBuildsCoordinator, and should
* only ever be used inside it.
*/
class ActiveIndexBuilds {
public:
/**
* Invariants that there are no index builds in-progress.
*/
~ActiveIndexBuilds();
/**
* The following functions all have equivalent definitions in IndexBuildsCoordinator. The
* IndexBuildsCoordinator functions forward to these functions. For descriptions of what they
* do, see IndexBuildsCoordinator.
*/
void waitForAllIndexBuildsToStopForShutdown(OperationContext* opCtx);
void assertNoIndexBuildInProgress() const;
void waitUntilAnIndexBuildFinishes(OperationContext* opCtx);
void sleepIndexBuilds_forTestOnly(bool sleep);
void verifyNoIndexBuilds_forTestOnly() const;
StatusWith<std::shared_ptr<ReplIndexBuildState>> getIndexBuild(const UUID& buildUUID) const;
void awaitNoIndexBuildInProgressForCollection(OperationContext* opCtx,
const UUID& collectionUUID,
IndexBuildProtocol protocol);
void awaitNoIndexBuildInProgressForCollection(OperationContext* opCtx,
const UUID& collectionUUID);
void awaitNoBgOpInProgForDb(OperationContext* opCtx, const DatabaseName& dbName);
/**
* Unregisters the index build.
*/
void unregisterIndexBuild(IndexBuildsManager* indexBuildsManager,
std::shared_ptr<ReplIndexBuildState> replIndexBuildState);
/**
* Returns a list of index builds matching the criteria 'indexBuildFilter'.
*/
using IndexBuildFilterFn = std::function<bool(const ReplIndexBuildState& replState)>;
std::vector<std::shared_ptr<ReplIndexBuildState>> filterIndexBuilds(
IndexBuildFilterFn indexBuildFilter) const;
/**
* Registers an index build so that the rest of the system can discover it.
*/
Status registerIndexBuild(std::shared_ptr<ReplIndexBuildState> replIndexBuildState);
/**
* Get the number of in-progress index builds.
*/
size_t getActiveIndexBuilds() const;
/**
* Provides passthrough access to ReplIndexBuildState for index build info.
* Does nothing if build UUID does not refer to an active index build.
*/
void appendBuildInfo(const UUID& buildUUID, BSONObjBuilder* builder) const;
/**
* When _sleepForTest is true, this function will sleep for 100ms and then check the value
* of _sleepForTest again.
*/
void sleepIfNecessary_forTestOnly() const;
private:
/**
* Helper function for filterIndexBuilds. This function is necessary because some callers
* already hold the mutex before calling this function.
*/
std::vector<std::shared_ptr<ReplIndexBuildState>> _filterIndexBuilds_inlock(
WithLock lk, IndexBuildFilterFn indexBuildFilter) const;
// Manages all of the below state
mutable Mutex _mutex = MONGO_MAKE_LATCH("ActiveIndexBuilds::_mutex");
// Build UUID to index build information
stdx::unordered_map<UUID, std::shared_ptr<ReplIndexBuildState>, UUID::Hash> _allIndexBuilds;
// Waiters are notified whenever _allIndexBuilds has something added or removed.
stdx::condition_variable _indexBuildsCondVar;
// Generation counter of completed index builds. Used in conjuction with the condition
// variable to receive notifications when an index build completes.
uint32_t _indexBuildsCompletedGen = 0;
bool _sleepForTest = false;
};
} // namespace mongo
|
