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
|
/**
* 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.
*/
#pragma once
#include "mongo/platform/basic.h"
#include <boost/filesystem.hpp>
#include "mongo/db/service_context.h"
namespace mongo {
/**
* A StorageRepairObserver is responsible for managing the state of the repair process. It
* handles state transitions so that failed repairs are recoverable and so that replica set
* corruption is not possible.
* */
class StorageRepairObserver {
public:
StorageRepairObserver(const StorageRepairObserver&) = delete;
StorageRepairObserver& operator=(const StorageRepairObserver&) = delete;
explicit StorageRepairObserver(const std::string& dbpath);
~StorageRepairObserver() = default;
static StorageRepairObserver* get(ServiceContext* service);
static void set(ServiceContext* service, std::unique_ptr<StorageRepairObserver> repairObserver);
/**
* Notify the repair observer that a database repair operation is about to begin.
*
* Failure to call onRepairDone() afterward will leave the node in an incomplete repaired state,
* and a subsequent restart will require to the node to run repair again.
*/
void onRepairStarted();
class Modification {
public:
static Modification invalidating(const std::string& description) {
return {description, true};
}
static Modification benign(const std::string& description) {
return {description, false};
}
const std::string& getDescription() const {
return _description;
}
bool isInvalidating() const {
return _invalidating;
}
private:
Modification(const std::string& description, bool invalidating)
: _description(description), _invalidating(invalidating) {}
std::string _description;
bool _invalidating;
};
/**
* Indicate that a data modification was made by repair. If even a single call is made, the
* replica set configuration will be invalidated.
*
* Provide a 'description' of the modification that will added to a list of modifications by
* getModifications();
*/
void invalidatingModification(const std::string& description);
/**
* Indicates a data modification was made by repair, but the change does not indicate the node's
* data is different than other replica set members. The replica set configuration will be left
* alone if all modifications are benign.
*
* Provide a 'description' of the modification that will added to a list of modifications by
* getModifications();
*/
void benignModification(const std::string& description);
/**
* This must be called to notify the repair observer that a database repair operation completed
* successfully. If any calls to invalidatingModification have been made, this invalidates the
* replica set configuration so this node will be unable to rejoin a replica set.
*
* May only be called after a call to onRepairStarted().
*/
void onRepairDone(OperationContext* opCtx);
/**
* Returns 'true' if this node is an incomplete repair state.
*/
bool isIncomplete() const {
return _repairState == RepairState::kIncomplete;
}
/**
* Returns 'true' if this node is done with a repair operation.
*/
bool isDone() const {
return _repairState == RepairState::kDone;
}
/**
* Returns 'true' if repair modified data in an invalidating way.
*
* May only be called after a call to onRepairDone().
*/
bool isDataInvalidated() const;
const std::vector<Modification>& getModifications() const {
return _modifications;
}
private:
enum class RepairState {
/**
* No data has been modified, but the state of the replica set configuration is still
* unknown. If the process were to exit in this state the server will be able to start up
* normally, except if the replica set configuration is invalidated.
*/
kPreStart,
/**
* Data is in the act of being repaired. Data may or may not have been modified by
* repair, but if the process were to exit in this state, we do not know. The server should
* require it not start normally without retrying a repair operation.
*/
kIncomplete,
/**
* Repair has completed. The server can be started normally unless data was modified and the
* server is started as a replica set.
*/
kDone
};
void _touchRepairIncompleteFile();
void _removeRepairIncompleteFile();
void _invalidateReplConfigIfNeeded(OperationContext* opCtx);
boost::filesystem::path _repairIncompleteFilePath;
RepairState _repairState;
std::vector<Modification> _modifications;
};
} // namespace mongo
|
