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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
/**
* 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 <boost/optional.hpp>
#include <string>
#include "mongo/base/owned_pointer_vector.h"
#include "mongo/bson/ordering.h"
#include "mongo/bson/timestamp.h"
#include "mongo/db/catalog/index_catalog_entry.h"
#include "mongo/db/index/multikey_paths.h"
#include "mongo/db/matcher/expression.h"
#include "mongo/db/record_id.h"
#include "mongo/db/storage/kv/kv_prefix.h"
#include "mongo/platform/atomic_word.h"
#include "mongo/stdx/mutex.h"
namespace mongo {
class CollatorInterface;
class CollectionQueryInfo;
class IndexAccessMethod;
class IndexDescriptor;
class MatchExpression;
class OperationContext;
class IndexCatalogEntryImpl : public IndexCatalogEntry {
IndexCatalogEntryImpl(const IndexCatalogEntryImpl&) = delete;
IndexCatalogEntryImpl& operator=(const IndexCatalogEntryImpl&) = delete;
public:
IndexCatalogEntryImpl(OperationContext* opCtx,
std::unique_ptr<IndexDescriptor> descriptor, // ownership passes to me
CollectionQueryInfo* queryInfo); // not owned, optional
~IndexCatalogEntryImpl() final;
const NamespaceString& ns() const final;
void init(std::unique_ptr<IndexAccessMethod> accessMethod) final;
IndexDescriptor* descriptor() final {
return _descriptor.get();
}
const IndexDescriptor* descriptor() const final {
return _descriptor.get();
}
IndexAccessMethod* accessMethod() final {
return _accessMethod.get();
}
const IndexAccessMethod* accessMethod() const final {
return _accessMethod.get();
}
bool isHybridBuilding() const final {
return _indexBuildInterceptor != nullptr;
}
IndexBuildInterceptor* indexBuildInterceptor() final {
return _indexBuildInterceptor;
}
const IndexBuildInterceptor* indexBuildInterceptor() const final {
return _indexBuildInterceptor;
}
void setIndexBuildInterceptor(IndexBuildInterceptor* interceptor) final {
_indexBuildInterceptor = interceptor;
}
const Ordering& ordering() const final {
return _ordering;
}
const MatchExpression* getFilterExpression() const final {
return _filterExpression.get();
}
const CollatorInterface* getCollator() const final {
return _collator.get();
}
/// ---------------------
void setIsReady(bool newIsReady) final;
// --
/**
* Returns true if this index is multikey, and returns false otherwise.
*/
bool isMultikey() const final;
/**
* Returns the path components that cause this index to be multikey if this index supports
* path-level multikey tracking, and returns an empty vector if path-level multikey tracking
* isn't supported.
*
* If this index supports path-level multikey tracking but isn't multikey, then this function
* returns a vector with size equal to the number of elements in the index key pattern where
* each element in the vector is an empty set.
*/
MultikeyPaths getMultikeyPaths(OperationContext* opCtx) const final;
/**
* Sets this index to be multikey. Information regarding which newly detected path components
* cause this index to be multikey can also be specified.
*
* If this index doesn't support path-level multikey tracking, then 'multikeyPaths' is ignored.
*
* If this index supports path-level multikey tracking, then 'multikeyPaths' must be a vector
* with size equal to the number of elements in the index key pattern. Additionally, at least
* one path component of the indexed fields must cause this index to be multikey.
*
* If isTrackingMultikeyPathInfo() is set on the OperationContext's MultikeyPathTracker,
* then after we confirm that we actually need to set the index as multikey, we will save the
* namespace, index name, and multikey paths on the OperationContext rather than set the index
* as multikey here.
*/
void setMultikey(OperationContext* opCtx, const MultikeyPaths& multikeyPaths) final;
// if this ready is ready for queries
bool isReady(OperationContext* opCtx) const final;
KVPrefix getPrefix() const final {
return _prefix;
}
/**
* If return value is not boost::none, reads with majority read concern using an older snapshot
* must treat this index as unfinished.
*/
boost::optional<Timestamp> getMinimumVisibleSnapshot() final {
return _minVisibleSnapshot;
}
/**
* Updates the minimum visible snapshot. The 'newMinimumVisibleSnapshot' is ignored if it would
* set the minimum visible snapshot backwards in time.
*/
void setMinimumVisibleSnapshot(Timestamp newMinimumVisibleSnapshot) final;
private:
class SetMultikeyChange;
bool _catalogIsReady(OperationContext* opCtx) const;
bool _catalogIsPresent(OperationContext* opCtx) const;
/**
* Retrieves the multikey information associated with this index from '_collection',
*
* See CollectionCatalogEntry::isIndexMultikey() for more details.
*/
bool _catalogIsMultikey(OperationContext* opCtx, MultikeyPaths* multikeyPaths) const;
KVPrefix _catalogGetPrefix(OperationContext* opCtx) const;
// -----
std::unique_ptr<IndexDescriptor> _descriptor; // owned here
CollectionQueryInfo* _queryInfo; // not owned here
std::unique_ptr<IndexAccessMethod> _accessMethod;
IndexBuildInterceptor* _indexBuildInterceptor = nullptr; // not owned here
std::unique_ptr<CollatorInterface> _collator;
std::unique_ptr<MatchExpression> _filterExpression;
// cached stuff
Ordering _ordering; // TODO: this might be b-tree specific
bool _isReady; // cache of NamespaceDetails info
// Set to true if this index supports path-level multikey tracking.
// '_indexTracksPathLevelMultikeyInfo' is effectively const after IndexCatalogEntry::init() is
// called.
bool _indexTracksPathLevelMultikeyInfo = false;
// Set to true if this index is multikey. '_isMultikey' serves as a cache of the information
// stored in the NamespaceDetails or DurableCatalog.
AtomicWord<bool> _isMultikey;
// Controls concurrent access to '_indexMultikeyPaths'. We acquire this mutex rather than the
// RESOURCE_METADATA lock as a performance optimization so that it is cheaper to detect whether
// there is actually any path-level multikey information to update or not.
mutable stdx::mutex _indexMultikeyPathsMutex;
// Non-empty only if '_indexTracksPathLevelMultikeyInfo' is true.
//
// If non-empty, '_indexMultikeyPaths' is a vector with size equal to the number of elements
// in the index key pattern. Each element in the vector is an ordered set of positions (starting
// at 0) into the corresponding indexed field that represent what prefixes of the indexed field
// causes the index to be multikey.
MultikeyPaths _indexMultikeyPaths;
// KVPrefix used to differentiate between index entries in different logical indexes sharing the
// same underlying sorted data interface.
const KVPrefix _prefix;
// The earliest snapshot that is allowed to read this index.
boost::optional<Timestamp> _minVisibleSnapshot;
};
} // namespace mongo
|