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
|
/**
* 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 <array>
#include "mongo/db/catalog/column_index_consistency.h"
#include "mongo/db/catalog/index_consistency.h"
#include "mongo/db/catalog/validate_state.h"
#include "mongo/util/progress_meter.h"
namespace mongo {
class IndexDescriptor;
class OperationContext;
/**
* The validate adaptor is used to keep track of collection and index consistency during a running
* collection validation operation.
*/
class ValidateAdaptor {
public:
ValidateAdaptor(OperationContext* opCtx, CollectionValidation::ValidateState* validateState)
: _keyBasedIndexConsistency(opCtx, validateState),
_columnIndexConsistency(opCtx, validateState),
_validateState(validateState) {}
/**
* Validates the record data and traverses through its key set to keep track of the
* index consistency.
*/
virtual Status validateRecord(OperationContext* opCtx,
const RecordId& recordId,
const RecordData& record,
long long* nNonCompliantDocuments,
size_t* dataSize,
ValidateResults* results);
/**
* Traverses the record store to retrieve every record and go through its document key
* set to keep track of the index consistency during a validation.
*/
void traverseRecordStore(OperationContext* opCtx,
ValidateResults* results,
BSONObjBuilder* output);
/**
* Traverses the index getting index entries to validate them and keep track of the index keys
* for index consistency.
*/
void traverseIndex(OperationContext* opCtx,
const IndexCatalogEntry* index,
int64_t* numTraversedKeys,
ValidateResults* results);
/**
* Traverses a record on the underlying index consistency objects.
*/
void traverseRecord(OperationContext* opCtx,
const CollectionPtr& coll,
const IndexCatalogEntry* index,
const RecordId& recordId,
const BSONObj& record,
ValidateResults* results);
/**
* Validates that the number of document keys matches the number of index keys previously
* traversed in traverseIndex().
*/
void validateIndexKeyCount(OperationContext* opCtx,
const IndexCatalogEntry* index,
IndexValidateResults& results);
/**
* Informs the index consistency objects that we're advancing to the second phase of index
* validation.
*/
void setSecondPhase();
/**
* Sets up the index consistency objects to limit memory usage in the second phase of index
* validation. Returns whether the memory limit is sufficient to report at least one index entry
* inconsistency and continue with the second phase of validation.
*/
bool limitMemoryUsageForSecondPhase(ValidateResults* result);
/**
* Returns true if the underlying index consistency objects have entry mismatches.
*/
bool haveEntryMismatch() const;
/**
* If repair mode enabled, try inserting _missingIndexEntries into indexes.
*/
void repairIndexEntries(OperationContext* opCtx, ValidateResults* results);
/**
* Records the errors gathered from the second phase of index validation into the provided
* ValidateResultsMap and ValidateResults.
*/
void addIndexEntryErrors(OperationContext* opCtx, ValidateResults* results);
private:
KeyStringIndexConsistency _keyBasedIndexConsistency;
ColumnIndexConsistency _columnIndexConsistency;
CollectionValidation::ValidateState* _validateState;
// Saves the record count from the record store traversal to be used later to validate the index
// entries count. Reset every time traverseRecordStore() is called.
long long _numRecords = 0;
// For reporting progress during record store and index traversal.
ProgressMeterHolder _progress;
};
} // namespace mongo
|
