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
|
/**
* Copyright (C) 2021-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/base/status.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/client/dbclient_connection.h"
#include "mongo/client/fetcher.h"
#include "mongo/db/repl/member_state.h"
#include "mongo/db/repl/sync_source_selector.h"
namespace mongo {
namespace repl {
/**
* An interface for the Initial Syncer that declares functions that are used by
* ReplicationCoordinatorImpl for initial sync.
*/
class InitialSyncerInterface {
public:
/**
* Type of function to create a database client
*
* Used for testing only.
*/
using CreateClientFn = std::function<std::unique_ptr<DBClientConnection>()>;
struct Options {
/** Function to return optime of last operation applied on this node */
using GetMyLastOptimeFn = std::function<OpTime()>;
/** Function to update optime of last operation applied on this node */
using SetMyLastOptimeFn = std::function<void(const OpTimeAndWallTime&)>;
/** Function to reset all optimes on this node (e.g. applied & durable). */
using ResetOptimesFn = std::function<void()>;
/** Function to set this node into a specific follower mode. */
using SetFollowerModeFn = std::function<bool(const MemberState&)>;
// Retry values
Milliseconds syncSourceRetryWait{1000};
Milliseconds initialSyncRetryWait{1000};
// InitialSyncer waits this long before retrying getApplierBatchCallback() if there are
// currently no operations available to apply or if the 'rsSyncApplyStop' failpoint is
// active. This default value is based on the duration in OplogBatcher::run().
Milliseconds getApplierBatchCallbackRetryWait{1000};
GetMyLastOptimeFn getMyLastOptime;
SetMyLastOptimeFn setMyLastOptime;
ResetOptimesFn resetOptimes;
SyncSourceSelector* syncSourceSelector = nullptr;
// The oplog fetcher will restart the oplog tailing query this many times on
// non-cancellation failures.
std::uint32_t oplogFetcherMaxFetcherRestarts = 0;
};
/**
* Callback function to report last applied optime of initial sync.
*/
typedef std::function<void(const StatusWith<OpTimeAndWallTime>& lastApplied)> OnCompletionFn;
virtual ~InitialSyncerInterface() = default;
/**
* Starts initial sync process, with the provided number of attempts
*/
virtual Status startup(OperationContext* opCtx, std::uint32_t maxAttempts) noexcept = 0;
/**
* Shuts down replication if "start" has been called, and blocks until shutdown has completed.
* Must be called before the executor that the initial syncer uses is shutdown.
*/
virtual Status shutdown() = 0;
/**
* Block until inactive.
*/
virtual void join() = 0;
/**
* Returns stats about the progress of initial sync. If initial sync is not in progress it
* returns an empty BSON object.
*/
virtual BSONObj getInitialSyncProgress() const = 0;
/**
* Cancels the current initial sync attempt if the initial syncer is active.
*/
virtual void cancelCurrentAttempt() = 0;
/**
* Returns the initial sync method that this initial syncer is using.
*/
virtual std::string getInitialSyncMethod() const = 0;
/**
* Returns whether user access to db 'local' should be allowed during this initial sync.
* Should be constant, and must not take any locks.
*/
virtual bool allowLocalDbAccess() const = 0;
};
} // namespace repl
} // namespace mongo
|
