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
|
/**
* 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.
*/
#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kCommand
#include "mongo/platform/basic.h"
#include "mongo/db/catalog/collection.h"
#include "mongo/db/catalog/collection_validation.h"
#include "mongo/db/client.h"
#include "mongo/db/commands.h"
#include "mongo/db/query/internal_plans.h"
#include "mongo/db/storage/durable_catalog.h"
#include "mongo/db/storage/record_store.h"
#include "mongo/util/fail_point_service.h"
#include "mongo/util/log.h"
#include "mongo/util/scopeguard.h"
namespace mongo {
// Sets the 'valid' result field to false and returns immediately.
MONGO_FAIL_POINT_DEFINE(validateCmdCollectionNotValid);
namespace {
// Protects the state below.
stdx::mutex _validationMutex;
// Holds the set of full `databaseName.collectionName` namespace strings in progress. Validation
// commands register themselves in this data structure so that subsequent commands on the same
// namespace will wait rather than run in parallel.
std::set<std::string> _validationsInProgress;
// This is waited upon if there is found to already be a validation command running on the targeted
// namespace, as _validationsInProgress would indicate. This is signaled when a validation command
// finishes on any namespace.
stdx::condition_variable _validationNotifier;
} // namespace
/**
* Example validate command:
* {
* validate: "collectionNameWithoutTheDBPart",
* full: <bool> // If true, a more thorough (and slower) collection validation is performed.
* }
*/
class ValidateCmd : public BasicCommand {
public:
ValidateCmd() : BasicCommand("validate") {}
AllowedOnSecondary secondaryAllowed(ServiceContext*) const override {
return AllowedOnSecondary::kAlways;
}
std::string help() const override {
return "Validate contents of a namespace by scanning its data structures for correctness. "
"Slow.\n"
"Add full:true option to do a more thorough check";
}
virtual bool supportsWriteConcern(const BSONObj& cmd) const override {
return false;
}
bool allowsAfterClusterTime(const BSONObj& cmd) const override {
return false;
}
bool canIgnorePrepareConflicts() const override {
return true;
}
virtual void addRequiredPrivileges(const std::string& dbname,
const BSONObj& cmdObj,
std::vector<Privilege>* out) const {
ActionSet actions;
actions.addAction(ActionType::validate);
out->push_back(Privilege(parseResourcePattern(dbname, cmdObj), actions));
}
bool run(OperationContext* opCtx,
const std::string& dbname,
const BSONObj& cmdObj,
BSONObjBuilder& result) {
if (MONGO_FAIL_POINT(validateCmdCollectionNotValid)) {
result.appendBool("valid", false);
return true;
}
const NamespaceString nss(CommandHelpers::parseNsCollectionRequired(dbname, cmdObj));
const bool background = cmdObj["background"].trueValue();
// Background validation requires the storage engine to support checkpoints because it
// performs the validation on a checkpoint using checkpoint cursors.
if (background && !opCtx->getServiceContext()->getStorageEngine()->supportsCheckpoints()) {
uasserted(ErrorCodes::CommandNotSupported,
str::stream() << "Running validate on collection " << nss
<< " with { background: true } is not supported on the "
<< storageGlobalParams.engine << " storage engine");
}
const bool full = cmdObj["full"].trueValue();
if (background && full) {
uasserted(ErrorCodes::CommandNotSupported,
str::stream() << "Running the validate command with both { background: true }"
<< " and { full: true } is not supported.");
}
ValidateCmdLevel level = kValidateNormal;
if (full) {
level = kValidateFull;
}
if (!serverGlobalParams.quiet.load()) {
LOG(0) << "CMD: validate " << nss.ns();
}
// Only one validation per collection can be in progress, the rest wait.
{
stdx::unique_lock<stdx::mutex> lock(_validationMutex);
try {
while (_validationsInProgress.find(nss.ns()) != _validationsInProgress.end()) {
opCtx->waitForConditionOrInterrupt(_validationNotifier, lock);
}
} catch (AssertionException& e) {
CommandHelpers::appendCommandStatusNoThrow(
result,
{ErrorCodes::CommandFailed,
str::stream() << "Exception thrown during validation: " << e.toString()});
return false;
}
_validationsInProgress.insert(nss.ns());
}
ON_BLOCK_EXIT([&] {
stdx::lock_guard<stdx::mutex> lock(_validationMutex);
_validationsInProgress.erase(nss.ns());
_validationNotifier.notify_all();
});
ValidateResults validateResults;
Status status = CollectionValidation::validate(
opCtx, nss, level, background, &validateResults, &result);
if (!status.isOK()) {
return CommandHelpers::appendCommandStatusNoThrow(result, status);
}
if (!full) {
validateResults.warnings.push_back(
"Some checks omitted for speed. use {full:true} option to do more thorough scan.");
}
result.appendBool("valid", validateResults.valid);
result.append("warnings", validateResults.warnings);
result.append("errors", validateResults.errors);
result.append("extraIndexEntries", validateResults.extraIndexEntries);
result.append("missingIndexEntries", validateResults.missingIndexEntries);
if (!validateResults.valid) {
result.append("advice",
"A corrupt namespace has been detected. See "
"http://dochub.mongodb.org/core/data-recovery for recovery steps.");
}
return true;
}
} validateCmd;
} // namespace mongo
|
