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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
|
/**
* Copyright (C) 2014 MongoDB 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.
*/
#pragma once
#include <vector>
#include "mongo/base/disallow_copying.h"
#include "mongo/base/status.h"
#include "mongo/db/repl/member_state.h"
#include "mongo/db/repl/repl_settings.h"
#include "mongo/db/repl/reporter.h"
#include "mongo/util/net/hostandport.h"
#include "mongo/util/time_support.h"
namespace mongo {
class BSONObj;
class BSONObjBuilder;
class IndexDescriptor;
class NamespaceString;
class OperationContext;
class Timestamp;
struct WriteConcernOptions;
namespace repl {
class BackgroundSync;
class HandshakeArgs;
class IsMasterResponse;
class OplogReader;
class OpTime;
class ReadAfterOpTimeArgs;
class ReadAfterOpTimeResponse;
class ReplSetDeclareElectionWinnerArgs;
class ReplSetDeclareElectionWinnerResponse;
class ReplSetHeartbeatArgs;
class ReplSetHeartbeatArgsV1;
class ReplSetHeartbeatResponse;
class ReplSetHtmlSummary;
class ReplSetRequestVotesArgs;
class ReplSetRequestVotesResponse;
class ReplicaSetConfig;
class UpdatePositionArgs;
/**
* Global variable that contains a std::string telling why master/slave halted
*
* "dead" means something really bad happened like replication falling completely out of sync.
* when non-null, we are dead and the string is informational
*
* TODO(dannenberg) remove when master slave goes
*/
extern const char *replAllDead;
/**
* The ReplicationCoordinator is responsible for coordinating the interaction of replication
* with the rest of the system. The public methods on ReplicationCoordinator are the public
* API that the replication subsystem presents to the rest of the codebase.
*/
class ReplicationCoordinator : public ReplicationProgressManager {
MONGO_DISALLOW_COPYING(ReplicationCoordinator);
public:
struct StatusAndDuration {
public:
Status status;
Milliseconds duration;
StatusAndDuration(const Status& stat, Milliseconds ms) : status(stat),
duration(ms) {}
};
virtual ~ReplicationCoordinator();
/**
* Does any initial bookkeeping needed to start replication, and instructs the other
* components of the replication system to start up whatever threads and do whatever
* initialization they need.
*/
virtual void startReplication(OperationContext* txn) = 0;
/**
* Does whatever cleanup is required to stop replication, including instructing the other
* components of the replication system to shut down and stop any threads they are using,
* blocking until all replication-related shutdown tasks are complete.
*/
virtual void shutdown() = 0;
/**
* Returns a reference to the parsed command line arguments that are related to replication.
*/
virtual const ReplSettings& getSettings() const = 0;
enum Mode {
modeNone = 0,
modeReplSet,
modeMasterSlave
};
/**
* Returns a value indicating whether this node was configured at start-up to run
* standalone, as part of a master-slave pair, or as a member of a replica set.
*/
virtual Mode getReplicationMode() const = 0;
/**
* Returns true if this node is configured to be a member of a replica set or master/slave
* setup.
*/
virtual bool isReplEnabled() const = 0;
/**
* Returns the current replica set state of this node (PRIMARY, SECONDARY, STARTUP, etc).
* It is invalid to call this unless getReplicationMode() == modeReplSet.
*/
virtual MemberState getMemberState() const = 0;
/**
* Returns true if this node is in state PRIMARY or SECONDARY.
*
* It is invalid to call this unless getReplicationMode() == modeReplSet.
*
* This method may be optimized to reduce synchronization overhead compared to
* reading the current member state with getMemberState().
*/
virtual bool isInPrimaryOrSecondaryState() const = 0;
/**
* Returns how slave delayed this node is configured to be.
*
* Raises a DBException if this node is not a member of the current replica set
* configuration.
*/
virtual Seconds getSlaveDelaySecs() const = 0;
/**
* Clears the list of sync sources we have blacklisted.
*/
virtual void clearSyncSourceBlacklist() = 0;
/**
* Blocks the calling thread for up to writeConcern.wTimeout millis, or until "opTime" has
* been replicated to at least a set of nodes that satisfies the writeConcern, whichever
* comes first. A writeConcern.wTimeout of 0 indicates no timeout (block forever) and a
* writeConcern.wTimeout of -1 indicates return immediately after checking. Return codes:
* ErrorCodes::WriteConcernFailed if the writeConcern.wTimeout is reached before
* the data has been sufficiently replicated
* ErrorCodes::ExceededTimeLimit if the txn->getMaxTimeMicrosRemaining is reached before
* the data has been sufficiently replicated
* ErrorCodes::NotMaster if the node is not Primary/Master
* ErrorCodes::UnknownReplWriteConcern if the writeConcern.wMode contains a write concern
* mode that is not known
* ErrorCodes::ShutdownInProgress if we are mid-shutdown
* ErrorCodes::Interrupted if the operation was killed with killop()
*/
virtual StatusAndDuration awaitReplication(const OperationContext* txn,
const OpTime& opTime,
const WriteConcernOptions& writeConcern) = 0;
/**
* Like awaitReplication(), above, but waits for the replication of the last operation
* performed on the client associated with "txn".
*/
virtual StatusAndDuration awaitReplicationOfLastOpForClient(
const OperationContext* txn,
const WriteConcernOptions& writeConcern) = 0;
/**
* Causes this node to relinquish being primary for at least 'stepdownTime'. If 'force' is
* false, before doing so it will wait for 'waitTime' for one other node to be within 10
* seconds of this node's optime before stepping down. Returns a Status with the code
* ErrorCodes::ExceededTimeLimit if no secondary catches up within waitTime,
* ErrorCodes::NotMaster if you are no longer primary when trying to step down,
* ErrorCodes::SecondaryAheadOfPrimary if we are primary but there is another node that
* seems to be ahead of us in replication, and Status::OK otherwise.
*/
virtual Status stepDown(OperationContext* txn,
bool force,
const Milliseconds& waitTime,
const Milliseconds& stepdownTime) = 0;
/**
* Returns true if the node can be considered master for the purpose of introspective
* commands such as isMaster() and rs.status().
*/
virtual bool isMasterForReportingPurposes() = 0;
/**
* Returns true if it is valid for this node to accept writes on the given database.
* Currently this is true only if this node is Primary, master in master/slave,
* a standalone, or is writing to the local database.
*
* If a node was started with the replSet argument, but has not yet received a config, it
* will not be able to receive writes to a database other than local (it will not be
* treated as standalone node).
*
* NOTE: This function can only be meaningfully called while the caller holds the global
* lock in some mode other than MODE_NONE.
*/
virtual bool canAcceptWritesForDatabase(StringData dbName) = 0;
/**
* Checks if the current replica set configuration can satisfy the given write concern.
*
* Things that are taken into consideration include:
* 1. If the set has enough data-bearing members.
* 2. If the write concern mode exists.
* 3. If there are enough members for the write concern mode specified.
*/
virtual Status checkIfWriteConcernCanBeSatisfied(
const WriteConcernOptions& writeConcern) const = 0;
/**
* Returns Status::OK() if it is valid for this node to serve reads on the given collection
* and an errorcode indicating why the node cannot if it cannot.
*/
virtual Status checkCanServeReadsFor(OperationContext* txn,
const NamespaceString& ns,
bool slaveOk) = 0;
/**
* Returns true if this node should ignore unique index constraints on new documents.
* Currently this is needed for nodes in STARTUP2, RECOVERING, and ROLLBACK states.
*/
virtual bool shouldIgnoreUniqueIndex(const IndexDescriptor* idx) = 0;
/**
* Updates our internal tracking of the last OpTime applied for the given slave
* identified by "rid". Only valid to call in master/slave mode
*/
virtual Status setLastOptimeForSlave(const OID& rid, const Timestamp& ts) = 0;
/**
* Updates our internal tracking of the last OpTime applied to this node.
*
* The new value of "opTime" must be no less than any prior value passed to this method, and
* it is the caller's job to properly synchronize this behavior. The exception to this rule
* is that after calls to resetLastOpTimeFromOplog(), the minimum acceptable value for
* "opTime" is reset based on the contents of the oplog, and may go backwards due to
* rollback.
*/
virtual void setMyLastOptime(const OpTime& opTime) = 0;
/**
* Same as above, but used during places we need to zero our last optime.
*/
virtual void resetMyLastOptime() = 0;
/**
* Updates our the message we include in heartbeat responses.
*/
virtual void setMyHeartbeatMessage(const std::string& msg) = 0;
/**
* Returns the last optime recorded by setMyLastOptime.
*/
virtual OpTime getMyLastOptime() const = 0;
/**
* Waits until the optime of the current node is at least the opTime specified in
* 'settings'.
*
* The returned ReadAfterOpTimeResponse object's didWait() method returns true if
* an attempt was made to wait for the specified opTime. Cases when this can be
* false could include:
*
* 1. No read after opTime was specified.
* 2. Attempting to do read after opTime when node is not a replica set member.
*
* Note: getDuration() on the returned ReadAfterOpTimeResponse will only be valid if
* its didWait() method returns true.
*/
virtual ReadAfterOpTimeResponse waitUntilOpTime(const OperationContext* txn,
const ReadAfterOpTimeArgs& settings) = 0;
/**
* Retrieves and returns the current election id, which is a unique id that is local to
* this node and changes every time we become primary.
* TODO(spencer): Use term instead.
*/
virtual OID getElectionId() = 0;
/**
* Returns the RID for this node. The RID is used to identify this node to our sync source
* when sending updates about our replication progress.
*/
virtual OID getMyRID() const = 0;
/**
* Returns the id for this node as specified in the current replica set configuration.
*/
virtual int getMyId() const = 0;
/**
* Sets this node into a specific follower mode.
*
* Returns true if the follower mode was successfully set. Returns false if the
* node is or becomes a leader before setFollowerMode completes.
*
* Follower modes are RS_STARTUP2 (initial sync), RS_SECONDARY, RS_ROLLBACK and
* RS_RECOVERING. They are the valid states of a node whose topology coordinator has the
* follower role.
*
* This is essentially an interface that allows the applier to prevent the node from
* becoming a candidate or accepting reads, depending on circumstances in the oplog
* application process.
*/
virtual bool setFollowerMode(const MemberState& newState) = 0;
/**
* Returns true if the coordinator wants the applier to pause application.
*
* If this returns true, the applier should call signalDrainComplete() when it has
* completed draining its operation buffer and no further ops are being applied.
*/
virtual bool isWaitingForApplierToDrain() = 0;
/**
* Signals that a previously requested pause and drain of the applier buffer
* has completed.
*
* This is an interface that allows the applier to reenable writes after
* a successful election triggers the draining of the applier buffer.
*/
virtual void signalDrainComplete(OperationContext* txn) = 0;
/**
* Signals the sync source feedback thread to wake up and send a handshake and
* replSetUpdatePosition command to our sync source.
*/
virtual void signalUpstreamUpdater() = 0;
/**
* 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 bool indicates whether or not the command was created.
*/
virtual bool prepareReplSetUpdatePositionCommand(BSONObjBuilder* cmdBuilder) = 0;
/**
* Handles an incoming replSetGetStatus command. Adds BSON to 'result'.
*/
virtual Status processReplSetGetStatus(BSONObjBuilder* result) = 0;
/**
* Handles an incoming isMaster command for a replica set node. Should not be
* called on a master-slave or standalone node.
*/
virtual void fillIsMasterForReplSet(IsMasterResponse* result) = 0;
/**
* Adds to "result" a description of the slaveInfo data structure used to map RIDs to their
* last known optimes.
*/
virtual void appendSlaveInfoData(BSONObjBuilder* result) = 0;
/**
* Returns a copy of the current ReplicaSetConfig.
*/
virtual ReplicaSetConfig getConfig() const = 0;
/**
* Handles an incoming replSetGetConfig command. Adds BSON to 'result'.
*/
virtual void processReplSetGetConfig(BSONObjBuilder* result) = 0;
/**
* Toggles maintenanceMode to the value expressed by 'activate'
* return Status::OK if the change worked, NotSecondary if it failed because we are
* PRIMARY, and OperationFailed if we are not currently in maintenance mode
*/
virtual Status setMaintenanceMode(bool activate) = 0;
/**
* Retrieves the current count of maintenanceMode and returns 'true' if greater than 0.
*/
virtual bool getMaintenanceMode() = 0;
/**
* Handles an incoming replSetSyncFrom command. Adds BSON to 'result'
* returns Status::OK if the sync target could be set and an ErrorCode indicating why it
* couldn't otherwise.
*/
virtual Status processReplSetSyncFrom(const HostAndPort& target,
BSONObjBuilder* resultObj) = 0;
/**
* Handles an incoming replSetFreeze command. Adds BSON to 'resultObj'
* returns Status::OK() if the node is a member of a replica set with a config and an
* error Status otherwise
*/
virtual Status processReplSetFreeze(int secs, BSONObjBuilder* resultObj) = 0;
/**
* Handles an incoming heartbeat command with arguments 'args'. Populates 'response';
* returns a Status with either OK or an error message.
*/
virtual Status processHeartbeat(const ReplSetHeartbeatArgs& args,
ReplSetHeartbeatResponse* response) = 0;
virtual Status processHeartbeatV1(const ReplSetHeartbeatArgsV1& args,
ReplSetHeartbeatResponse* response) = 0;
/**
* Arguments for the replSetReconfig command.
*/
struct ReplSetReconfigArgs {
BSONObj newConfigObj;
bool force;
};
/**
* Handles an incoming replSetReconfig command. Adds BSON to 'resultObj';
* returns a Status with either OK or an error message.
*/
virtual Status processReplSetReconfig(OperationContext* txn,
const ReplSetReconfigArgs& args,
BSONObjBuilder* resultObj) = 0;
/*
* Handles an incoming replSetInitiate command. If "configObj" is empty, generates a default
* configuration to use.
* Adds BSON to 'resultObj'; returns a Status with either OK or an error message.
*/
virtual Status processReplSetInitiate(OperationContext* txn,
const BSONObj& configObj,
BSONObjBuilder* resultObj) = 0;
/*
* Handles an incoming replSetGetRBID command.
* Adds BSON to 'resultObj'; returns a Status with either OK or an error message.
*/
virtual Status processReplSetGetRBID(BSONObjBuilder* resultObj) = 0;
/**
* Increments this process's rollback id. Called every time a rollback occurs.
*/
virtual void incrementRollbackID() = 0;
/**
* Arguments to the replSetFresh command.
*/
struct ReplSetFreshArgs {
std::string setName; // Name of the replset
HostAndPort who; // host and port of the member that sent the replSetFresh command
unsigned id; // replSet id of the member that sent the replSetFresh command
int cfgver; // replSet config version that the member who sent the command thinks it has
Timestamp opTime; // last optime seen by the member who sent the replSetFresh command
};
/*
* Handles an incoming replSetFresh command.
* Adds BSON to 'resultObj'; returns a Status with either OK or an error message.
*/
virtual Status processReplSetFresh(const ReplSetFreshArgs& args,
BSONObjBuilder* resultObj) = 0;
/**
* Arguments to the replSetElect command.
*/
struct ReplSetElectArgs {
std::string set; // Name of the replset
int whoid; // replSet id of the member that sent the replSetFresh command
int cfgver; // replSet config version that the member who sent the command thinks it has
OID round; // unique ID for this election
};
/*
* Handles an incoming replSetElect command.
* Adds BSON to 'resultObj'; returns a Status with either OK or an error message.
*/
virtual Status processReplSetElect(const ReplSetElectArgs& args,
BSONObjBuilder* resultObj) = 0;
/**
* Handles an incoming replSetUpdatePosition command, updating each node's oplog progress.
* Returns Status::OK() if all updates are processed correctly, NodeNotFound
* if any updating node cannot be found in the config, InvalidReplicaSetConfig if the
* "configVersion" sent in any of the updates doesn't match our config version, or
* NotMasterOrSecondaryCode if we are in state REMOVED or otherwise don't have a valid
* replica set config.
* If a non-OK status is returned, it is unspecified whether none or some of the updates
* were applied.
* "configVersion" will be populated with our config version if and only if we return
* InvalidReplicaSetConfig.
*/
virtual Status processReplSetUpdatePosition(const UpdatePositionArgs& updates,
long long* configVersion) = 0;
/**
* Handles an incoming Handshake command. Associates the node's 'remoteID' with its
* 'handshake' object. This association is used to update internal representation of
* replication progress and to forward the node's replication progress upstream when this
* node is being chained through in master/slave replication.
*
* Returns ErrorCodes::IllegalOperation if we're not running with master/slave replication.
*/
virtual Status processHandshake(OperationContext* txn, const HandshakeArgs& handshake) = 0;
/**
* Returns a bool indicating whether or not this node builds indexes.
*/
virtual bool buildsIndexes() = 0;
/**
* Returns a vector of members that have applied the operation with OpTime 'op'.
*/
virtual std::vector<HostAndPort> getHostsWrittenTo(const OpTime& op) = 0;
/**
* Returns a vector of the members other than ourself in the replica set, as specified in
* the replica set config. Invalid to call if we are not in replica set mode. Returns
* an empty vector if we do not have a valid config.
*/
virtual std::vector<HostAndPort> getOtherNodesInReplSet() const = 0;
/**
* Returns a BSONObj containing a representation of the current default write concern.
*/
virtual WriteConcernOptions getGetLastErrorDefault() = 0;
/**
* Checks that the --replSet flag was passed when starting up the node and that the node
* has a valid replica set config.
*
* Returns a Status indicating whether those conditions are met with errorcode
* NoReplicationEnabled if --replSet was not present during start up or with errorcode
* NotYetInitialized in the absence of a valid config. Also adds error info to "result".
*/
virtual Status checkReplEnabledForCommand(BSONObjBuilder* result) = 0;
/**
* Chooses a viable sync source, or, if none available, returns empty HostAndPort.
*/
virtual HostAndPort chooseNewSyncSource() = 0;
/**
* Blacklists choosing 'host' as a sync source until time 'until'.
*/
virtual void blacklistSyncSource(const HostAndPort& host, Date_t until) = 0;
/**
* Loads the optime from the last op in the oplog into the coordinator's lastOpApplied
* value.
*/
virtual void resetLastOpTimeFromOplog(OperationContext* txn) = 0;
/**
* Determines if a new sync source should be considered.
* currentSource: the current sync source
*/
virtual bool shouldChangeSyncSource(const HostAndPort& currentSource) = 0;
/**
* Returns the OpTime of the latest replica set-committed op known to this server.
* Committed means a majority of the voting nodes of the config are known to have the
* operation in their oplogs. This implies such ops will never be rolled back.
*/
virtual OpTime getLastCommittedOpTime() const = 0;
/*
* Handles an incoming replSetRequestVotes command.
* Adds BSON to 'resultObj'; returns a Status with either OK or an error message.
*/
virtual Status processReplSetRequestVotes(OperationContext* txn,
const ReplSetRequestVotesArgs& args,
ReplSetRequestVotesResponse* response) = 0;
/*
* Handles an incoming replSetDeclareElectionWinner command.
* Returns a Status with either OK or an error message.
* Populates responseTerm with the current term from our perspective.
*/
virtual Status processReplSetDeclareElectionWinner(
const ReplSetDeclareElectionWinnerArgs& args,
long long* responseTerm) = 0;
/**
* Prepares a BSONObj describing the current term, primary, and lastOp information.
*/
virtual void prepareCursorResponseInfo(BSONObjBuilder* objBuilder) = 0;
/**
* Returns true if the V1 election protocol is being used and false otherwise.
*/
virtual bool isV1ElectionProtocol() = 0;
/**
* Writes into 'output' all the information needed to generate a summary of the current
* replication state for use by the web interface.
*/
virtual void summarizeAsHtml(ReplSetHtmlSummary* output) = 0;
protected:
ReplicationCoordinator();
};
} // namespace repl
} // namespace mongo
|