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
|
/**
* Copyright (C) 2019-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/operation_context.h"
#include "mongo/db/read_write_concern_defaults_gen.h"
#include "mongo/db/repl/read_concern_args.h"
#include "mongo/db/service_context.h"
#include "mongo/db/write_concern_options.h"
#include "mongo/platform/mutex.h"
#include "mongo/util/concurrency/thread_pool.h"
#include "mongo/util/concurrency/with_lock.h"
#include "mongo/util/read_through_cache.h"
namespace mongo {
/**
* Class to manage Read Concern and Write Concern (RWC) defaults.
*/
class ReadWriteConcernDefaults {
public:
/**
* Consistent names for the classes that define a ReadConcern and a WriteConcern.
*/
using ReadConcern = repl::ReadConcernArgs;
using WriteConcern = WriteConcernOptions;
using FetchDefaultsFn = unique_function<boost::optional<RWConcernDefault>(OperationContext*)>;
static constexpr StringData readConcernFieldName = ReadConcern::kReadConcernFieldName;
static constexpr StringData writeConcernFieldName = WriteConcern::kWriteConcernField;
// The _id of the persisted default read/write concern document.
static constexpr StringData kPersistedDocumentId = "ReadWriteConcernDefaults"_sd;
static ReadWriteConcernDefaults& get(ServiceContext* service);
static ReadWriteConcernDefaults& get(OperationContext* opCtx);
static void create(ServiceContext* service, FetchDefaultsFn fetchDefaultsFn);
ReadWriteConcernDefaults(ServiceContext* service, FetchDefaultsFn fetchDefaultsFn);
~ReadWriteConcernDefaults();
/**
* Syntactic sugar around 'getDefault' below. A return value of boost::none means that there is
* no default specified for that particular concern.
*/
boost::optional<ReadConcern> getDefaultReadConcern(OperationContext* opCtx);
boost::optional<WriteConcern> getDefaultWriteConcern(OperationContext* opCtx);
/**
* Returns the implicit default read concern.
*/
repl::ReadConcernArgs getImplicitDefaultReadConcern();
class RWConcernDefaultAndTime : public RWConcernDefault {
public:
RWConcernDefaultAndTime() = default;
RWConcernDefaultAndTime(RWConcernDefault rwcd, Date_t localUpdateWallClockTime)
: RWConcernDefault(std::move(rwcd)),
_localUpdateWallClockTime(localUpdateWallClockTime) {}
Date_t localUpdateWallClockTime() const {
return _localUpdateWallClockTime;
}
private:
Date_t _localUpdateWallClockTime;
};
/**
* Returns the current set of read/write concern defaults along with the wallclock time when
* they were cached (for diagnostic purposes).
*/
RWConcernDefaultAndTime getDefault(OperationContext* opCtx);
/**
* Returns true if the RC level is permissible to use as a default, and false if it cannot be a
* RC default.
*/
static bool isSuitableReadConcernLevel(repl::ReadConcernLevel level);
/**
* Checks if the given RWC is suitable to use as a default, and uasserts if not.
*/
static void checkSuitabilityAsDefault(const ReadConcern& rc);
static void checkSuitabilityAsDefault(const WriteConcern& wc);
/**
* Examines a document key affected by a write to config.settings and will register a WUOW
* onCommit handler that invalidates this cache when the operation commits if the write affects
* the read/write concern defaults document.
*/
void observeDirectWriteToConfigSettings(OperationContext* opCtx,
BSONElement idElem,
boost::optional<BSONObj> newDoc);
/**
* Generates a new read and write concern default to be persisted on disk, without updating the
* cached value.
* At least one of the `rc` or `wc` params must be set.
* Will generate and use a new epoch and setTime for the updated defaults, which are returned.
* Validates the supplied read and write concerns can serve as defaults.
*/
RWConcernDefault generateNewCWRWCToBeSavedOnDisk(OperationContext* opCtx,
const boost::optional<ReadConcern>& rc,
const boost::optional<WriteConcern>& wc);
/**
* Returns true if cluster-wide write concern is set.
*/
bool isCWWCSet(OperationContext* opCtx);
/**
* Invalidates the cached RWC defaults, causing them to be refreshed.
*
* After this call returns, the read methods below (getDefault, getDefaultReadConcern,
* getDefaultWriteConcern) may continue returning the invalidated defaults, until they have been
* replaced by the refreshed values. This is to avoid stalling CRUD ops (and other ops that
* need RC/WC) during refresh.
*/
void invalidate();
/**
* Manually looks up the latest defaults, and if their epoch is more recent than the cached
* defaults or indicates there are no defaults, then update the cache with the new defaults.
*/
void refreshIfNecessary(OperationContext* opCtx);
/**
* Sets the given read write concern as the defaults in the cache.
*/
void setDefault(OperationContext* opCtx, RWConcernDefault&& rwc);
/**
* Sets implicit default write concern whether it should be majority or not.
* Should be called once on startup.
*/
void setImplicitDefaultWriteConcernMajority(bool newImplicitDefaultWCMajority);
/**
* Gets a bool indicating whether the implicit default write concern is majority.
* This function should only be used for testing purposes.
*/
boost::optional<bool> getImplicitDefaultWriteConcernMajority_forTest();
/**
* Gets the cluster-wide write concern (CWWC) persisted on disk.
*/
boost::optional<WriteConcern> getCWWC(OperationContext* opCtx);
private:
enum class Type { kReadWriteConcernEntry };
/**
* Gets cluster wide read and write concerns (CWRWC) persisted on disk.
*/
boost::optional<RWConcernDefaultAndTime> _getDefaultCWRWCFromDisk(OperationContext* opCtx);
class Cache : public ReadThroughCache<Type, RWConcernDefault> {
Cache(const Cache&) = delete;
Cache& operator=(const Cache&) = delete;
public:
Cache(ServiceContext* service,
ThreadPoolInterface& threadPool,
FetchDefaultsFn fetchDefaultsFn);
virtual ~Cache() = default;
boost::optional<RWConcernDefault> lookup(OperationContext* opCtx);
private:
Mutex _mutex = MONGO_MAKE_LATCH("ReadWriteConcernDefaults::Cache");
FetchDefaultsFn _fetchDefaultsFn;
};
Cache _defaults;
// Thread pool on which to perform loading of the cached RWC defaults
ThreadPool _threadPool;
// Indicate whether implicit default write concern should be majority or not.
boost::optional<bool> _implicitDefaultWriteConcernMajority;
};
} // namespace mongo
|
