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
|
/**
* 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 <map>
#include <string>
#include "mongo/db/repl_index_build_state.h"
#include "mongo/stdx/condition_variable.h"
#include "mongo/util/concurrency/with_lock.h"
#include "mongo/util/uuid.h"
namespace mongo {
class IndexBuildsManager;
/**
* Tracks index builds for a particular collection. Provides access to index build information by
* collection and index name. Can be used to act on all index builds for a collection, wait upon the
* completion of all index builds, and provide collection level index build information.
*
* The owner of a CollectionIndexBuildsTracker instance must instantiate a mutex to use along with
* the data structure to ensure it remains consistent across single or multiple function accesses.
*
* This is intended to only be used by the IndexBuildsCoordinator class. Functions expecting a lock
* to be passed in as a parameter require an already locked IndexBuildsCoordinator::_mutex in this
* case.
*/
class CollectionIndexBuildsTracker {
CollectionIndexBuildsTracker(const CollectionIndexBuildsTracker&) = delete;
CollectionIndexBuildsTracker& operator=(const CollectionIndexBuildsTracker&) = delete;
public:
CollectionIndexBuildsTracker() = default;
~CollectionIndexBuildsTracker();
/**
* Starts tracking the specified index build on the collection.
*/
void addIndexBuild(WithLock, std::shared_ptr<ReplIndexBuildState> buildInfo);
/**
* Stops tracking the specified index build on the collection.
*/
void removeIndexBuild(WithLock, std::shared_ptr<ReplIndexBuildState> buildInfo);
std::shared_ptr<ReplIndexBuildState> getIndexBuildState(WithLock, StringData indexName) const;
bool hasIndexBuildState(WithLock, StringData indexName) const;
std::vector<UUID> getIndexBuildUUIDs(WithLock) const;
/**
* Runs the provided function operation on all this collection's index builds
*
* 'func' returns void and must not throw. It should not have failure state to return.
*/
void runOperationOnAllBuilds(
WithLock,
IndexBuildsManager* indexBuildsManager,
std::function<void(WithLock,
IndexBuildsManager* indexBuildsManager,
std::shared_ptr<ReplIndexBuildState> replIndexBuildState,
const std::string& reason)> func,
const std::string& reason) noexcept;
/**
* Note that this is the number of index builders, and that each index builder can be building
* several indexes.
*/
int getNumberOfIndexBuilds(WithLock) const;
/**
* Returns when no index builds remain on this collection.
*/
void waitUntilNoIndexBuildsRemain(stdx::unique_lock<Latch>& lk);
/**
* Returns when the index build with the given build UUID is no longer active. When the build
* UUID does not correspond to an active index build, returns immediately.
*/
void waitUntilIndexBuildFinished(stdx::unique_lock<Latch>& lk, const UUID& buildUUID);
private:
// Maps of index build states on the collection, by build UUID and index name.
stdx::unordered_map<UUID, std::shared_ptr<ReplIndexBuildState>, UUID::Hash>
_buildStateByBuildUUID;
stdx::unordered_map<std::string, std::shared_ptr<ReplIndexBuildState>> _buildStateByIndexName;
// Condition variable that is signaled when an index build has finished on the collection. The
// accompanying mutex for this condition variable comes from the owner managing this class
// instance.
stdx::condition_variable _indexBuildFinishedCondVar;
};
} // namespace mongo
|
