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
|
/**
* 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 <memory>
#include "mongo/base/status.h"
#include "mongo/config.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/wire_version.h"
#include "mongo/executor/connection_metrics.h"
#include "mongo/transport/session.h"
#include "mongo/transport/ssl_connection_context.h"
#include "mongo/util/functional.h"
#include "mongo/util/future.h"
#include "mongo/util/out_of_line_executor.h"
#include "mongo/util/time_support.h"
#ifdef MONGO_CONFIG_SSL
#include "mongo/util/net/ssl_manager.h"
#endif
namespace mongo {
class OperationContext;
namespace transport {
enum ConnectSSLMode { kGlobalSSLMode, kEnableSSL, kDisableSSL };
class Reactor;
using ReactorHandle = std::shared_ptr<Reactor>;
/**
* The TransportLayer moves Messages between transport::Endpoints and the database.
* This class owns an Acceptor that generates new endpoints from which it can
* source Messages.
*
* The TransportLayer creates Session objects and maps them internally to
* endpoints. New Sessions are passed to the database (via a ServiceEntryPoint)
* to be run. The database must then call additional methods on the TransportLayer
* to manage the Session in a get-Message, handle-Message, return-Message cycle.
* It must do this on its own thread(s).
*
* References to the TransportLayer should be stored on service context objects.
*/
class TransportLayer {
TransportLayer(const TransportLayer&) = delete;
TransportLayer& operator=(const TransportLayer&) = delete;
public:
static const Status SessionUnknownStatus;
static const Status ShutdownStatus;
static const Status TicketSessionUnknownStatus;
static const Status TicketSessionClosedStatus;
friend class Session;
explicit TransportLayer(const WireSpec& wireSpec) : _wireSpec(wireSpec) {}
virtual ~TransportLayer() = default;
virtual StatusWith<SessionHandle> connect(
HostAndPort peer,
ConnectSSLMode sslMode,
Milliseconds timeout,
boost::optional<TransientSSLParams> transientSSLParams = boost::none) = 0;
virtual Future<SessionHandle> asyncConnect(
HostAndPort peer,
ConnectSSLMode sslMode,
const ReactorHandle& reactor,
Milliseconds timeout,
std::shared_ptr<ConnectionMetrics> connectionMetrics,
std::shared_ptr<const SSLConnectionContext> transientSSLContext) = 0;
/**
* Start the TransportLayer. After this point, the TransportLayer will begin accepting active
* sessions from new transport::Endpoints.
*/
virtual Status start() = 0;
/**
* Shut the TransportLayer down. After this point, the TransportLayer will
* end all active sessions and won't accept new transport::Endpoints. Any
* future calls to wait() or asyncWait() will fail. This method is synchronous and
* will not return until all sessions have ended and any network connections have been
* closed.
*/
virtual void shutdown() = 0;
/**
* Optional method for subclasses to setup their state before being ready to accept
* connections.
*/
virtual Status setup() = 0;
/** Allows a `TransportLayer` to contribute to a serverStatus readout. */
virtual void appendStatsForServerStatus(BSONObjBuilder* bob) const {}
/** Allows a `TransportLayer` to contribute to a FTDC readout. */
virtual void appendStatsForFTDC(BSONObjBuilder& bob) const {}
enum WhichReactor { kIngress, kEgress, kNewReactor };
virtual ReactorHandle getReactor(WhichReactor which) = 0;
virtual BatonHandle makeBaton(OperationContext* opCtx) const {
return opCtx->getServiceContext()->makeBaton(opCtx);
}
std::shared_ptr<const WireSpec::Specification> getWireSpec() const {
return _wireSpec.get();
}
#ifdef MONGO_CONFIG_SSL
/** Rotate the in-use certificates for new connections. */
virtual Status rotateCertificates(std::shared_ptr<SSLManagerInterface> manager,
bool asyncOCSPStaple) = 0;
/**
* Creates a transient SSL context using targeted (non default) SSL params.
* @param transientSSLParams overrides any value in stored SSLConnectionContext.
* @param optionalManager provides an optional SSL manager, otherwise the default one will be
* used.
*/
virtual StatusWith<std::shared_ptr<const transport::SSLConnectionContext>>
createTransientSSLContext(const TransientSSLParams& transientSSLParams) = 0;
#endif
private:
const WireSpec& _wireSpec;
};
class ReactorTimer {
public:
ReactorTimer();
ReactorTimer(const ReactorTimer&) = delete;
ReactorTimer& operator=(const ReactorTimer&) = delete;
/*
* The destructor calls cancel() to ensure outstanding Futures are filled.
*/
virtual ~ReactorTimer() = default;
size_t id() const {
return _id;
}
/*
* Cancel any outstanding future from waitFor/waitUntil. The future will be filled with an
* ErrorCodes::CallbackCancelled status.
*
* If no future is outstanding, then this is a noop.
*/
virtual void cancel(const BatonHandle& baton = nullptr) = 0;
/*
* Returns a future that will be filled with Status::OK after the deadline has passed.
*
* Calling this implicitly calls cancel().
*/
virtual Future<void> waitUntil(Date_t deadline, const BatonHandle& baton = nullptr) = 0;
private:
const size_t _id;
};
class Reactor : public OutOfLineExecutor {
public:
Reactor(const Reactor&) = delete;
Reactor& operator=(const Reactor&) = delete;
virtual ~Reactor() = default;
/*
* Run the event loop of the reactor until stop() is called.
*/
virtual void run() noexcept = 0;
virtual void runFor(Milliseconds time) noexcept = 0;
virtual void stop() = 0;
virtual void drain() = 0;
virtual void schedule(Task task) = 0;
virtual void dispatch(Task task) = 0;
virtual bool onReactorThread() const = 0;
/*
* Makes a timer tied to this reactor's event loop. Timeout callbacks will be
* executed in a thread calling run() or runFor().
*/
virtual std::unique_ptr<ReactorTimer> makeTimer() = 0;
virtual Date_t now() = 0;
virtual void appendStats(BSONObjBuilder& bob) const = 0;
protected:
Reactor() = default;
};
} // namespace transport
} // namespace mongo
|
