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
|
/**
* Copyright (C) 2016 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* 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 GNU Affero General 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 <list>
#include <memory>
#include "mongo/base/disallow_copying.h"
#include "mongo/db/s/collection_metadata.h"
#include "mongo/s/catalog/type_chunk.h"
#include "mongo/stdx/memory.h"
namespace mongo {
class ScopedCollectionMetadata;
class MetadataManager {
MONGO_DISALLOW_COPYING(MetadataManager);
public:
MetadataManager();
~MetadataManager();
/**
* An ActiveMetadata must be set before this function can be called.
*
* Increments the usage counter of the active metadata and returns an RAII object, which
* contains the currently active metadata. When the usageCounter goes to zero, the RAII
* object going out of scope will call _removeMetadata.
*/
ScopedCollectionMetadata getActiveMetadata();
/**
* Changes the active metadata and if there are current users of the current metadata,
* puts it in the _metadataInUse set.
*/
void setActiveMetadata(std::unique_ptr<CollectionMetadata> newMetadata);
/**
* Adds a new range to be cleaned up.
* The newly introduced range must not overlap with the existing ranges.
*/
void addRangeToClean(const ChunkRange& range);
/**
* Removes the specified range from the ranges to be cleaned up.
*/
void removeRangeToClean(const ChunkRange& range);
/**
* Gets copy of _rangesToClean map (see below).
*/
std::map<BSONObj, ChunkRange> getCopyOfRanges();
/*
* Appends information on all the chunk ranges in rangesToClean to builder.
*/
void append(BSONObjBuilder* builder);
private:
friend class ScopedCollectionMetadata;
struct CollectionMetadataTracker {
public:
/**
* Creates a new CollectionMetadataTracker, with the usageCounter initialized to zero.
*/
CollectionMetadataTracker(std::unique_ptr<CollectionMetadata> m);
std::unique_ptr<CollectionMetadata> metadata;
uint32_t usageCounter{0};
};
/**
* Removes the CollectionMetadata stored in the tracker from the _metadataInUse
* list (if it's there).
*/
void _removeMetadata_inlock(CollectionMetadataTracker* metadataTracker);
void _addRangeToClean_inlock(const ChunkRange& range);
void _removeRangeToClean_inlock(const ChunkRange& range);
std::unique_ptr<CollectionMetadataTracker> _activeMetadataTracker;
std::list<std::unique_ptr<CollectionMetadataTracker>> _metadataInUse;
// Contains the information of which ranges of sharding keys need to
// be deleted from the shard. The map is from the minimum value of the
// range to be deleted (e.g. BSON("key" << 0)) to the entire chunk range.
std::map<BSONObj, ChunkRange> _rangesToClean;
stdx::mutex _managerLock;
};
class ScopedCollectionMetadata {
MONGO_DISALLOW_COPYING(ScopedCollectionMetadata);
public:
/**
* Decrements the usageCounter and conditionally makes a call to _removeMetadata on
* the tracker if the count has reached zero.
*/
~ScopedCollectionMetadata();
ScopedCollectionMetadata(ScopedCollectionMetadata&& other);
ScopedCollectionMetadata& operator=(ScopedCollectionMetadata&& other);
/**
* Dereferencing the ScopedCollectionMetadata will dereference the internal CollectionMetadata.
*/
CollectionMetadata* operator->();
CollectionMetadata* getMetadata();
private:
friend ScopedCollectionMetadata MetadataManager::getActiveMetadata();
/**
* Increments the counter in the CollectionMetadataTracker.
*/
ScopedCollectionMetadata(MetadataManager* manager,
MetadataManager::CollectionMetadataTracker* tracker);
MetadataManager* _manager;
MetadataManager::CollectionMetadataTracker* _tracker;
};
} // namespace mongo
|
