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
|
/**
* 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/op_observer/op_observer_noop.h"
namespace mongo {
/**
* OpObserver for user write blocking. On write operations, checks whether the current global user
* write blocking state allows the write, and uasserts if not.
*/
class UserWriteBlockModeOpObserver final : public OpObserverNoop {
UserWriteBlockModeOpObserver(const UserWriteBlockModeOpObserver&) = delete;
UserWriteBlockModeOpObserver& operator=(const UserWriteBlockModeOpObserver&) = delete;
public:
UserWriteBlockModeOpObserver() = default;
~UserWriteBlockModeOpObserver() = default;
// Operations to check for allowed writes.
// CUD operations
void onInserts(OperationContext* opCtx,
const CollectionPtr& coll,
std::vector<InsertStatement>::const_iterator first,
std::vector<InsertStatement>::const_iterator last,
std::vector<bool> fromMigrate,
bool defaultFromMigrate,
InsertsOpStateAccumulator* opAccumulator = nullptr) final;
void onInsertGlobalIndexKey(OperationContext* opCtx,
const NamespaceString& globalIndexNss,
const UUID& globalIndexUuid,
const BSONObj& key,
const BSONObj& docKey) final{};
void onDeleteGlobalIndexKey(OperationContext* opCtx,
const NamespaceString& globalIndexNss,
const UUID& globalIndexUuid,
const BSONObj& key,
const BSONObj& docKey) final {}
void onUpdate(OperationContext* opCtx,
const OplogUpdateEntryArgs& args,
OpStateAccumulator* opAccumulator = nullptr) final;
void onDelete(OperationContext* opCtx,
const CollectionPtr& coll,
StmtId stmtId,
const OplogDeleteEntryArgs& args,
OpStateAccumulator* opAccumulator = nullptr) final;
// DDL operations
void onCreateIndex(OperationContext* opCtx,
const NamespaceString& nss,
const UUID& uuid,
BSONObj indexDoc,
bool fromMigrate) final;
// We need to check the startIndexBuild ops because onCreateIndex is only called for empty
// collections.
void onStartIndexBuild(OperationContext* opCtx,
const NamespaceString& nss,
const UUID& collUUID,
const UUID& indexBuildUUID,
const std::vector<BSONObj>& indexes,
bool fromMigrate) final;
void onStartIndexBuildSinglePhase(OperationContext* opCtx, const NamespaceString& nss) final;
void onCreateCollection(OperationContext* opCtx,
const CollectionPtr& coll,
const NamespaceString& collectionName,
const CollectionOptions& options,
const BSONObj& idIndex,
const OplogSlot& createOpTime,
bool fromMigrate) final;
void onCollMod(OperationContext* opCtx,
const NamespaceString& nss,
const UUID& uuid,
const BSONObj& collModCmd,
const CollectionOptions& oldCollOptions,
boost::optional<IndexCollModInfo> indexInfo) final;
void onDropDatabase(OperationContext* opCtx, const DatabaseName& dbName) final;
repl::OpTime onDropCollection(OperationContext* opCtx,
const NamespaceString& collectionName,
const UUID& uuid,
std::uint64_t numRecords,
CollectionDropType dropType,
bool markFromMigrate) final;
void onDropIndex(OperationContext* opCtx,
const NamespaceString& nss,
const UUID& uuid,
const std::string& indexName,
const BSONObj& indexInfo) final;
// onRenameCollection is only for renaming to a nonexistent target NS, so we need
// preRenameCollection too.
repl::OpTime preRenameCollection(OperationContext* opCtx,
const NamespaceString& fromCollection,
const NamespaceString& toCollection,
const UUID& uuid,
const boost::optional<UUID>& dropTargetUUID,
std::uint64_t numRecords,
bool stayTemp,
bool markFromMigrate) final;
void onRenameCollection(OperationContext* opCtx,
const NamespaceString& fromCollection,
const NamespaceString& toCollection,
const UUID& uuid,
const boost::optional<UUID>& dropTargetUUID,
std::uint64_t numRecords,
bool stayTemp,
bool markFromMigrate) final;
void onImportCollection(OperationContext* opCtx,
const UUID& importUUID,
const NamespaceString& nss,
long long numRecords,
long long dataSize,
const BSONObj& catalogEntry,
const BSONObj& storageMetadata,
bool isDryRun) final;
// Note aboutToDelete is unchecked, but defined.
void aboutToDelete(OperationContext* opCtx,
const CollectionPtr& coll,
const BSONObj& doc) final;
void onReplicationRollback(OperationContext* opCtx, const RollbackObserverInfo& rbInfo) final;
// Noop operations below with explanations (don't perform any check).
// onModifyCollectionShardingIndexCatalog() is unchecked because sharded collection indexes
// catalog are modified from internal commands.
// onCreateGlobalIndex() and onDropGlobalIndex() are unchecked because global indexes are
// created from internal commands.
// Index builds committing (onCommitIndexBuild()) can be left unchecked since we kill any active
// index builds before enabling write blocking. This means any index build which gets to the
// commit phase while write blocking is active was started and hit the onStartIndexBuild hook
// with write blocking active, and thus must be allowed under user write blocking.
// At the moment we are leaving the onAbortIndexBuildSinglePhase() and onAbortIndexBuild() as
// unchecked. This is because they can be called from both user and internal codepaths, and
// we don't want to risk throwing an assert for the internal paths.
// We don't need to check postRenameCollection() and preRenameCollection (they are in the same
// WUOW).
// The on*Transaction*() transaction commit related hooks don't need to be checked, because all
// of the operations inside the transaction are checked and they all execute in one WUOW.
private:
// uasserts that a write to the given namespace is allowed under the current user write blocking
// setting.
void _checkWriteAllowed(OperationContext* opCtx, const NamespaceString& nss);
};
} // namespace mongo
|
