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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
/**
* Copyright (C) 2013 10gen 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.
*/
#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kCommand
#include "mongo/platform/basic.h"
#include <boost/optional.hpp>
#include <string>
#include "mongo/db/auth/action_type.h"
#include "mongo/db/auth/authorization_manager.h"
#include "mongo/db/auth/authorization_session.h"
#include "mongo/db/auth/privilege.h"
#include "mongo/db/catalog_raii.h"
#include "mongo/db/commands.h"
#include "mongo/db/field_parser.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/range_arithmetic.h"
#include "mongo/db/s/chunk_move_write_concern_options.h"
#include "mongo/db/s/collection_sharding_state.h"
#include "mongo/db/s/shard_filtering_metadata_refresh.h"
#include "mongo/db/s/sharding_state.h"
#include "mongo/db/service_context.h"
#include "mongo/s/request_types/migration_secondary_throttle_options.h"
#include "mongo/util/log.h"
namespace mongo {
namespace {
enum CleanupResult { CleanupResult_Done, CleanupResult_Continue, CleanupResult_Error };
/**
* Cleans up one range of orphaned data starting from a range that overlaps or starts at
* 'startingFromKey'. If empty, startingFromKey is the minimum key of the sharded range.
*
* @return CleanupResult_Continue and 'stoppedAtKey' if orphaned range was found and cleaned
* @return CleanupResult_Done if no orphaned ranges remain
* @return CleanupResult_Error and 'errMsg' if an error occurred
*
* If the collection is not sharded, returns CleanupResult_Done.
*/
CleanupResult cleanupOrphanedData(OperationContext* opCtx,
const NamespaceString& ns,
const BSONObj& startingFromKeyConst,
const WriteConcernOptions& secondaryThrottle,
BSONObj* stoppedAtKey,
std::string* errMsg) {
BSONObj startingFromKey = startingFromKeyConst;
boost::optional<ChunkRange> targetRange;
CollectionShardingState::CleanupNotification notifn;
{
AutoGetCollection autoColl(opCtx, ns, MODE_IX);
const auto css = CollectionShardingState::get(opCtx, ns);
auto metadata = css->getMetadata(opCtx);
if (!metadata) {
log() << "skipping orphaned data cleanup for " << ns.toString()
<< ", collection is not sharded";
return CleanupResult_Done;
}
BSONObj keyPattern = metadata->getKeyPattern();
if (!startingFromKey.isEmpty()) {
if (!metadata->isValidKey(startingFromKey)) {
*errMsg = str::stream() << "could not cleanup orphaned data, start key "
<< startingFromKey << " does not match shard key pattern "
<< keyPattern;
log() << *errMsg;
return CleanupResult_Error;
}
} else {
startingFromKey = metadata->getMinKey();
}
targetRange = css->getNextOrphanRange(startingFromKey);
if (!targetRange) {
LOG(1) << "cleanupOrphaned requested for " << ns.toString() << " starting from "
<< redact(startingFromKey) << ", no orphan ranges remain";
return CleanupResult_Done;
}
*stoppedAtKey = targetRange->getMax();
notifn = css->cleanUpRange(*targetRange, CollectionShardingState::kNow);
}
// Sleep waiting for our own deletion. We don't actually care about any others, so there is no
// need to call css::waitForClean() here.
LOG(1) << "cleanupOrphaned requested for " << ns.toString() << " starting from "
<< redact(startingFromKey) << ", removing next orphan range "
<< redact(targetRange->toString()) << "; waiting...";
Status result = notifn.waitStatus(opCtx);
LOG(1) << "Finished waiting for last " << ns.toString() << " orphan range cleanup";
if (!result.isOK()) {
log() << redact(result.reason());
*errMsg = result.reason();
return CleanupResult_Error;
}
return CleanupResult_Continue;
}
/**
* Cleanup orphaned data command. Called on a particular namespace, and if the collection
* is sharded will clean up a single orphaned data range which overlaps or starts after a
* passed-in 'startingFromKey'. Returns true and a 'stoppedAtKey' (which will start a
* search for the next orphaned range if the command is called again) or no key if there
* are no more orphaned ranges in the collection.
*
* If the collection is not sharded, returns true but no 'stoppedAtKey'.
* On failure, returns false and an error message.
*
* Calling this command repeatedly until no 'stoppedAtKey' is returned ensures that the
* full collection range is searched for orphaned documents, but since sharding state may
* change between calls there is no guarantee that all orphaned documents were found unless
* the balancer is off.
*
* Safe to call with the balancer on.
*
* Format:
*
* {
* cleanupOrphaned: <ns>,
* // optional parameters:
* startingAtKey: { <shardKeyValue> }, // defaults to lowest value
* secondaryThrottle: <bool>, // defaults to true
* // defaults to { w: "majority", wtimeout: 60000 }. Applies to individual writes.
* writeConcern: { <writeConcern options> }
* }
*/
class CleanupOrphanedCommand : public ErrmsgCommandDeprecated {
public:
CleanupOrphanedCommand() : ErrmsgCommandDeprecated("cleanupOrphaned") {}
AllowedOnSecondary secondaryAllowed(ServiceContext*) const override {
return AllowedOnSecondary::kNever;
}
bool adminOnly() const override {
return true;
}
Status checkAuthForCommand(Client* client,
const std::string& dbname,
const BSONObj& cmdObj) const override {
if (!AuthorizationSession::get(client)->isAuthorizedForActionsOnResource(
ResourcePattern::forClusterResource(), ActionType::cleanupOrphaned)) {
return Status(ErrorCodes::Unauthorized, "Not authorized for cleanupOrphaned command.");
}
return Status::OK();
}
bool supportsWriteConcern(const BSONObj& cmd) const override {
return true;
}
// Input
static BSONField<std::string> nsField;
static BSONField<BSONObj> startingFromKeyField;
// Output
static BSONField<BSONObj> stoppedAtKeyField;
bool errmsgRun(OperationContext* opCtx,
std::string const& db,
const BSONObj& cmdObj,
std::string& errmsg,
BSONObjBuilder& result) override {
std::string ns;
if (!FieldParser::extract(cmdObj, nsField, &ns, &errmsg)) {
return false;
}
const NamespaceString nss(ns);
uassert(ErrorCodes::InvalidNamespace,
str::stream() << "Invalid namespace: " << nss.ns(),
nss.isValid());
BSONObj startingFromKey;
if (!FieldParser::extract(cmdObj, startingFromKeyField, &startingFromKey, &errmsg)) {
return false;
}
const auto secondaryThrottle =
uassertStatusOK(MigrationSecondaryThrottleOptions::createFromCommand(cmdObj));
const auto writeConcern = uassertStatusOK(
ChunkMoveWriteConcernOptions::getEffectiveWriteConcern(opCtx, secondaryThrottle));
ShardingState* const shardingState = ShardingState::get(opCtx);
if (!shardingState->enabled()) {
errmsg = str::stream() << "server is not part of a sharded cluster or "
<< "the sharding metadata is not yet initialized.";
return false;
}
forceShardFilteringMetadataRefresh(opCtx, nss, true /* forceRefreshFromThisThread */);
BSONObj stoppedAtKey;
CleanupResult cleanupResult =
cleanupOrphanedData(opCtx, nss, startingFromKey, writeConcern, &stoppedAtKey, &errmsg);
if (cleanupResult == CleanupResult_Error) {
return false;
}
if (cleanupResult == CleanupResult_Continue) {
result.append(stoppedAtKeyField(), stoppedAtKey);
} else {
dassert(cleanupResult == CleanupResult_Done);
}
return true;
}
} cleanupOrphanedCmd;
BSONField<std::string> CleanupOrphanedCommand::nsField("cleanupOrphaned");
BSONField<BSONObj> CleanupOrphanedCommand::startingFromKeyField("startingFromKey");
BSONField<BSONObj> CleanupOrphanedCommand::stoppedAtKeyField("stoppedAtKey");
} // namespace
} // namespace mongo
|