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
|
/**
* 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 <functional>
#include "mongo/base/status.h"
#include "mongo/base/status_with.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/repl/replication_coordinator.h"
#include "mongo/executor/task_executor.h"
#include "mongo/platform/condition_variable.h"
#include "mongo/platform/mutex.h"
#include "mongo/util/time_support.h"
namespace mongo {
namespace repl {
/**
* Once scheduled, the reporter will periodically send the current replication progress, obtained
* by invoking "_prepareReplSetUpdatePositionCommandFn", to its sync source until it encounters
* an error.
*
* If the sync source cannot accept the current format (used by server versions 3.2.4 and above) of
* the "replSetUpdatePosition" command, the reporter will not abort and instead downgrade the format
* of the command it will send upstream.
*
* While the reporter is active, it will be in one of three states:
* 1) triggered and waiting to send command to sync source as soon as possible.
* 2) waiting for command response from sync source.
* 3) waiting for at least "_keepAliveInterval" ms before sending command to sync source.
*
* Calling trigger() while the reporter is in state 1 or 2 will cause the reporter to immediately
* send a new command upon receiving a successful command response.
*
* Calling trigger() while it is in state 3 sends a command upstream and cancels the current
* keep alive timeout, resetting the keep alive schedule.
*/
class Reporter {
Reporter(const Reporter&) = delete;
Reporter& operator=(const Reporter&) = delete;
public:
/**
* Prepares a BSONObj describing an invocation of the replSetUpdatePosition command that can
* be sent to this node's sync source to update it about our progress in replication.
*
* The returned status indicates whether or not the command was created.
*/
using PrepareReplSetUpdatePositionCommandFn = std::function<StatusWith<BSONObj>()>;
Reporter(executor::TaskExecutor* executor,
PrepareReplSetUpdatePositionCommandFn prepareReplSetUpdatePositionCommandFn,
const HostAndPort& target,
Milliseconds keepAliveInterval,
Milliseconds updatePositionTimeout);
virtual ~Reporter();
/**
* Returns sync target.
*/
HostAndPort getTarget() const;
/**
* Returns an informational string.
*/
std::string toString() const;
/**
* Returns keep alive interval.
* Reporter will periodically send replication status to sync source every "_keepAliveInterval"
* until an error occurs.
*/
Milliseconds getKeepAliveInterval() const;
/**
* Returns true if a remote command has been scheduled (but not completed)
* with the executor.
*/
bool isActive() const;
/**
* Returns true if new data is available while a remote command is in progress.
* The reporter will schedule a subsequent remote update immediately upon successful
* completion of the previous command instead of when the keep alive callback runs.
*/
bool isWaitingToSendReport() const;
/**
* Cancels both scheduled and active remote command requests.
* Returns immediately if the Reporter is not active.
*/
void shutdown();
/**
* Waits until Reporter is inactive and returns reporter status.
*/
Status join();
/**
* Signals to the Reporter that there is new information to be sent to the "_target" server.
* Returns the _status, indicating any error the Reporter has encountered.
*/
Status trigger();
// ================== Test support API ===================
/**
* Returns scheduled time of keep alive timeout handler.
*/
Date_t getKeepAliveTimeoutWhen_forTest() const;
Status getStatus_forTest() const;
private:
/**
* Returns true if reporter is active.
*/
bool _isActive_inlock() const;
/**
* Prepares remote command to be run by the executor.
*/
StatusWith<BSONObj> _prepareCommand();
/**
* Schedules remote command to be run by the executor with the given network timeout.
*/
void _sendCommand_inlock(BSONObj commandRequest, Milliseconds netTimeout);
/**
* Callback for processing response from remote command.
*/
void _processResponseCallback(const executor::TaskExecutor::RemoteCommandCallbackArgs& rcbd);
/**
* Callback for preparing and sending remote command.
*/
void _prepareAndSendCommandCallback(const executor::TaskExecutor::CallbackArgs& args,
bool fromTrigger);
/**
* Signals end of Reporter work and notifies waiters.
*/
void _onShutdown_inlock();
// Not owned by us.
executor::TaskExecutor* const _executor;
// Prepares update command object.
const PrepareReplSetUpdatePositionCommandFn _prepareReplSetUpdatePositionCommandFn;
// Host to whom the Reporter sends updates.
const HostAndPort _target;
// Reporter will send updates every "_keepAliveInterval" ms until the reporter is canceled or
// encounters an error.
const Milliseconds _keepAliveInterval;
// The network timeout used when sending an updatePosition command to our sync source.
const Milliseconds _updatePositionTimeout;
// Protects member data of this Reporter declared below.
mutable Mutex _mutex = MONGO_MAKE_LATCH("Reporter::_mutex");
mutable stdx::condition_variable _condition;
// Stores the most recent Status returned from the executor.
Status _status = Status::OK();
// _isWaitingToSendReporter is true when Reporter is scheduled to be run by the executor and
// subsequent updates have come in.
bool _isWaitingToSendReporter = false;
// Callback handle to the scheduled remote command.
executor::TaskExecutor::CallbackHandle _remoteCommandCallbackHandle;
// Callback handle to the scheduled task for preparing and sending the remote command.
executor::TaskExecutor::CallbackHandle _prepareAndSendCommandCallbackHandle;
// Keep alive timeout callback will not run before this time.
// If this date is Date_t(), the callback is either unscheduled or canceled.
// Used for testing only.
Date_t _keepAliveTimeoutWhen;
};
} // namespace repl
} // namespace mongo
|
