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
|
/**
* Copyright (C) 2022-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 "mongo/db/namespace_string.h"
#include "mongo/s/catalog/type_index_catalog_gen.h"
#include "mongo/s/index_version.h"
namespace mongo {
using IndexCatalogTypeMap = StringDataMap<IndexCatalogType>;
class GlobalIndexesCache {
public:
GlobalIndexesCache(boost::optional<Timestamp> indexVersion, IndexCatalogTypeMap&& indexes)
: _indexVersion(indexVersion), _indexes(indexes) {}
bool empty() const;
boost::optional<Timestamp> getVersion() const;
size_t numIndexes() const;
bool contains(const StringData& name) const;
void add(const IndexCatalogType& index, const Timestamp& indexVersion);
void remove(const StringData& name, const Timestamp& indexVersion);
void clear();
private:
boost::optional<Timestamp> _indexVersion;
IndexCatalogTypeMap _indexes;
};
/**
* Constructed to be used exclusively by the CatalogCache as a vector clock (Time) to drive
* IndexCache's lookups.
*
* The CollectionIndexes class contains a timestamp for the collection generation which resets to 0
* if the collection is dropped, in which case the versions cannot be compared.
*
* This class wraps a CollectionIndexes object with a node-local sequence number
* (_epochDisambiguatingSequenceNum) that allows the comparision.
*
*/
class ComparableIndexVersion {
public:
/**
* Creates a ComparableIndexVersion that wraps the given CollectionIndexes.
* Each object created through this method will have a local sequence number greater than the
* previously created ones.
*/
static ComparableIndexVersion makeComparableIndexVersion(const CollectionIndexes& version);
/**
* Creates a new instance which will artificially be greater than any previously created
* ComparableIndexVersion and smaller than any instance created afterwards. Used as means to
* cause the collections cache to attempt a refresh in situations where causal consistency
* cannot be inferred.
*/
static ComparableIndexVersion makeComparableIndexVersionForForcedRefresh();
/**
* Empty constructor needed by the ReadThroughCache.
*
* Instances created through this constructor will be always less then the ones created through
* the two static constructors, but they do not carry any meaningful value and can only be used
* for comparison purposes.
*/
ComparableIndexVersion() = default;
std::string toString() const;
bool operator==(const ComparableIndexVersion& other) const;
bool operator!=(const ComparableIndexVersion& other) const {
return !(*this == other);
}
/**
* In case the two compared instances have different generations, the most recently created one
* will be greater, otherwise the comparision will be driven by the index versions of the
* underlying CollectionIndexes.
*/
bool operator<(const ComparableIndexVersion& other) const;
bool operator>(const ComparableIndexVersion& other) const {
return other < *this;
}
bool operator<=(const ComparableIndexVersion& other) const {
return !(*this > other);
}
bool operator>=(const ComparableIndexVersion& other) const {
return !(*this < other);
}
private:
friend class CatalogCache;
static AtomicWord<uint64_t> _epochDisambiguatingSequenceNumSource;
static AtomicWord<uint64_t> _forcedRefreshSequenceNumSource;
ComparableIndexVersion(uint64_t forcedRefreshSequenceNum,
boost::optional<CollectionIndexes> version,
uint64_t epochDisambiguatingSequenceNum)
: _forcedRefreshSequenceNum(forcedRefreshSequenceNum),
_indexVersion(std::move(version)),
_epochDisambiguatingSequenceNum(epochDisambiguatingSequenceNum) {}
void setCollectionIndexes(const CollectionIndexes& version);
uint64_t _forcedRefreshSequenceNum{0};
boost::optional<CollectionIndexes> _indexVersion;
// Locally incremented sequence number that allows to compare two colection versions with
// different generations. Each new ComparableIndexVersion will have a greater sequence number
// than the ones created before.
uint64_t _epochDisambiguatingSequenceNum{0};
};
} // namespace mongo
|
