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
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
|
/**
* 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.
*/
#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kASIO
#include "mongo/platform/basic.h"
#include "mongo/executor/network_interface_tl.h"
#include "mongo/db/commands/test_commands_enabled.h"
#include "mongo/db/server_options.h"
#include "mongo/executor/connection_pool_tl.h"
#include "mongo/logv2/log.h"
#include "mongo/rpc/get_status_from_command_result.h"
#include "mongo/transport/transport_layer_manager.h"
#include "mongo/util/concurrency/idle_thread_block.h"
#include "mongo/util/log.h"
#include "mongo/util/net/socket_utils.h"
namespace mongo {
namespace executor {
/**
* SynchronizedCounters is synchronized bucket of event counts for commands
*/
class NetworkInterfaceTL::SynchronizedCounters {
public:
auto get() const {
stdx::lock_guard lk(_mutex);
return _data;
}
void recordResult(const Status& status) {
stdx::lock_guard lk(_mutex);
if (status.isOK()) {
// Increment the count of commands that received a valid response
++_data.succeeded;
} else if (ErrorCodes::isExceededTimeLimitError(status)) {
// Increment the count of commands that experienced a local timeout
// Note that these commands do not count as "failed".
++_data.timedOut;
} else if (ErrorCodes::isCancelationError(status)) {
// Increment the count of commands that were canceled locally
++_data.canceled;
} else if (ErrorCodes::isShutdownError(status)) {
// Increment the count of commands that received an unrecoverable response
++_data.failedRemotely;
} else {
// Increment the count of commands that experienced a network failure
++_data.failed;
}
}
/**
* Increment the count of commands sent over the network
*/
void recordSent() {
++_data.sent;
}
private:
mutable Mutex _mutex = MONGO_MAKE_LATCH(HierarchicalAcquisitionLevel(0),
"NetworkInterfaceTL::SynchronizedCounters::_mutex");
Counters _data;
};
NetworkInterfaceTL::NetworkInterfaceTL(std::string instanceName,
ConnectionPool::Options connPoolOpts,
ServiceContext* svcCtx,
std::unique_ptr<NetworkConnectionHook> onConnectHook,
std::unique_ptr<rpc::EgressMetadataHook> metadataHook)
: _instanceName(std::move(instanceName)),
_svcCtx(svcCtx),
_connPoolOpts(std::move(connPoolOpts)),
_onConnectHook(std::move(onConnectHook)),
_metadataHook(std::move(metadataHook)),
_state(kDefault) {
if (_svcCtx) {
_tl = _svcCtx->getTransportLayer();
}
// Even if you have a service context, it may not have a transport layer (mostly for unittests).
if (!_tl) {
LOGV2_WARNING(22601, "No TransportLayer configured during NetworkInterface startup");
_ownedTransportLayer =
transport::TransportLayerManager::makeAndStartDefaultEgressTransportLayer();
_tl = _ownedTransportLayer.get();
}
_reactor = _tl->getReactor(transport::TransportLayer::kNewReactor);
auto typeFactory = std::make_unique<connection_pool_tl::TLTypeFactory>(
_reactor, _tl, std::move(_onConnectHook), _connPoolOpts);
_pool = std::make_shared<ConnectionPool>(
std::move(typeFactory), std::string("NetworkInterfaceTL-") + _instanceName, _connPoolOpts);
if (getTestCommandsEnabled()) {
_counters = std::make_unique<SynchronizedCounters>();
}
}
std::string NetworkInterfaceTL::getDiagnosticString() {
return "DEPRECATED: getDiagnosticString is deprecated in NetworkInterfaceTL";
}
void NetworkInterfaceTL::appendConnectionStats(ConnectionPoolStats* stats) const {
auto pool = [&] {
stdx::lock_guard<Latch> lk(_mutex);
return _pool.get();
}();
if (pool)
pool->appendConnectionStats(stats);
}
NetworkInterface::Counters NetworkInterfaceTL::getCounters() const {
invariant(_counters);
return _counters->get();
}
std::string NetworkInterfaceTL::getHostName() {
return getHostNameCached();
}
void NetworkInterfaceTL::startup() {
stdx::lock_guard<Latch> lk(_mutex);
_ioThread = stdx::thread([this] {
setThreadName(_instanceName);
_run();
});
invariant(_state.swap(kStarted) == kDefault);
}
void NetworkInterfaceTL::_run() {
LOGV2_DEBUG(22592, 2, "The NetworkInterfaceTL reactor thread is spinning up");
// This returns when the reactor is stopped in shutdown()
_reactor->run();
// Note that the pool will shutdown again when the ConnectionPool dtor runs
// This prevents new timers from being set, calls all cancels via the factory registry, and
// destructs all connections for all existing pools.
_pool->shutdown();
// Close out all remaining tasks in the reactor now that they've all been canceled.
_reactor->drain();
LOGV2_DEBUG(22593, 2, "NetworkInterfaceTL shutdown successfully");
}
void NetworkInterfaceTL::shutdown() {
if (_state.swap(kStopped) != kStarted)
return;
LOGV2_DEBUG(22594, 2, "Shutting down network interface.");
// Stop the reactor/thread first so that nothing runs on a partially dtor'd pool.
_reactor->stop();
_cancelAllAlarms();
_ioThread.join();
}
bool NetworkInterfaceTL::inShutdown() const {
return _state.load() == kStopped;
}
void NetworkInterfaceTL::waitForWork() {
stdx::unique_lock<Latch> lk(_mutex);
MONGO_IDLE_THREAD_BLOCK;
_workReadyCond.wait(lk, [this] { return _isExecutorRunnable; });
}
void NetworkInterfaceTL::waitForWorkUntil(Date_t when) {
stdx::unique_lock<Latch> lk(_mutex);
MONGO_IDLE_THREAD_BLOCK;
_workReadyCond.wait_until(lk, when.toSystemTimePoint(), [this] { return _isExecutorRunnable; });
}
void NetworkInterfaceTL::signalWorkAvailable() {
stdx::unique_lock<Latch> lk(_mutex);
if (!_isExecutorRunnable) {
_isExecutorRunnable = true;
_workReadyCond.notify_one();
}
}
Date_t NetworkInterfaceTL::now() {
// TODO This check is because we set up NetworkInterfaces in MONGO_INITIALIZERS and then expect
// this method to work before the NI is started.
if (!_reactor) {
return Date_t::now();
}
return _reactor->now();
}
NetworkInterfaceTL::CommandState::CommandState(NetworkInterfaceTL* interface_,
RemoteCommandRequestOnAny request_,
const TaskExecutor::CallbackHandle& cbHandle_)
: interface(interface_),
requestOnAny(std::move(request_)),
cbHandle(cbHandle_),
finishLine(maxRequestFailures()) {}
auto NetworkInterfaceTL::CommandState::make(NetworkInterfaceTL* interface,
RemoteCommandRequestOnAny request,
const TaskExecutor::CallbackHandle& cbHandle) {
auto state = std::make_shared<CommandState>(interface, std::move(request), cbHandle);
auto [promise, future] = makePromiseFuture<RemoteCommandOnAnyResponse>();
state->promise = std::move(promise);
future = std::move(future)
.onError([state](Status error) {
// If command promise was canceled or timed out, wrap the error in a RCRsp
return RemoteCommandOnAnyResponse(
boost::none, std::move(error), state->stopwatch.elapsed());
})
.tapAll([state](const auto& swRequest) {
// swRequest is either populated from the success path or the value returning
// onError above. swRequest.isOK() should not be possible.
invariant(swRequest.isOK());
// At this point, the command has either been sent and returned an RCRsp or
// has received a local interruption that was wrapped in a RCRsp.
state->tryFinish(swRequest.getValue().status);
});
{
stdx::lock_guard lk(interface->_inProgressMutex);
interface->_inProgress.insert({cbHandle, state});
}
return std::pair(state, std::move(future));
}
AsyncDBClient* NetworkInterfaceTL::RequestState::client() noexcept {
if (!conn) {
return nullptr;
}
return checked_cast<connection_pool_tl::TLConnection*>(conn.get())->client();
}
void NetworkInterfaceTL::CommandState::setTimer() {
if (deadline == RemoteCommandRequest::kNoExpirationDate) {
return;
}
const auto nowVal = interface->now();
if (nowVal >= deadline) {
auto connDuration = stopwatch.elapsed();
uasserted(ErrorCodes::NetworkInterfaceExceededTimeLimit,
str::stream() << "Remote command timed out while waiting to get a "
"connection from the pool, took "
<< connDuration << ", timeout was set to " << requestOnAny.timeout);
}
// TODO reform with SERVER-41459
timer = interface->_reactor->makeTimer();
timer->waitUntil(deadline, baton).getAsync([this, anchor = shared_from_this()](Status status) {
if (!status.isOK()) {
return;
}
if (!finishLine.arriveStrongly()) {
// If we didn't cross the command finishLine first, the promise is already fulfilled
return;
}
const std::string message = str::stream() << "Request " << requestOnAny.id << " timed out"
<< ", deadline was " << deadline.toString()
<< ", op was " << redact(requestOnAny.toString());
LOGV2_DEBUG(22595, 2, "{message}", "message"_attr = message);
promise.setError(Status(ErrorCodes::NetworkInterfaceExceededTimeLimit, message));
});
}
void NetworkInterfaceTL::RequestState::returnConnection(Status status) noexcept {
// Settle the connection object on the reactor
invariant(conn);
invariant(interface()->_reactor->onReactorThread());
auto connToReturn = std::exchange(conn, {});
if (!status.isOK()) {
connToReturn->indicateFailure(std::move(status));
return;
}
connToReturn->indicateUsed();
connToReturn->indicateSuccess();
}
void NetworkInterfaceTL::CommandState::tryFinish(Status status) noexcept {
invariant(finishLine.isReady());
if (timer) {
// The command has resolved one way or another,
timer->cancel(baton);
}
if (auto requestState = requestStatePtr.lock(); requestState && !status.isOK()) {
requestState->cancel();
}
if (interface->_counters) {
// Increment our counters for the integration test
interface->_counters->recordResult(status);
}
{
// We've finished, we're not in progress anymore
stdx::lock_guard lk(interface->_inProgressMutex);
interface->_inProgress.erase(cbHandle);
}
}
void NetworkInterfaceTL::RequestState::cancel() noexcept {
if (connFinishLine.arriveStrongly()) {
// We've canceled before any connections were acquired, we're all good.
return;
}
auto& reactor = interface()->_reactor;
// If we failed, then get the client to finish up.
// Note: CommandState::returnConnection() and CommandState::cancel() run on the reactor
// thread only. One goes first and then the other, so there isn't a risk of canceling
// the next command to run on the connection.
if (reactor->onReactorThread()) {
if (auto clientPtr = client()) {
// If we have a client, cancel it
clientPtr->cancel(cmdState->baton);
}
} else {
ExecutorFuture<void>(reactor).getAsync([this, anchor = shared_from_this()](Status status) {
invariant(status.isOK());
if (auto clientPtr = client()) {
// If we have a client, cancel it
clientPtr->cancel(cmdState->baton);
}
});
}
}
NetworkInterfaceTL::RequestState::~RequestState() {
invariant(!conn);
}
Status NetworkInterfaceTL::startCommand(const TaskExecutor::CallbackHandle& cbHandle,
RemoteCommandRequestOnAny& request,
RemoteCommandCompletionFn&& onFinish,
const BatonHandle& baton) {
if (inShutdown()) {
return {ErrorCodes::ShutdownInProgress, "NetworkInterface shutdown in progress"};
}
LOGV2_DEBUG(22596,
logSeverityV1toV2(kDiagnosticLogLevel).toInt(),
"startCommand: {request}",
"request"_attr = redact(request.toString()));
if (_metadataHook) {
BSONObjBuilder newMetadata(std::move(request.metadata));
auto status = _metadataHook->writeRequestMetadata(request.opCtx, &newMetadata);
if (!status.isOK()) {
return status;
}
request.metadata = newMetadata.obj();
}
auto [cmdState, future] = CommandState::make(this, request, cbHandle);
if (cmdState->requestOnAny.timeout != cmdState->requestOnAny.kNoTimeout) {
cmdState->deadline = cmdState->stopwatch.start() + cmdState->requestOnAny.timeout;
}
cmdState->baton = baton;
/**
* It is important that onFinish() runs out of line. That said, we can't thenRunOn() arbitrarily
* without doing extra context switches and delaying execution. The cmdState promise can be
* fulfilled in these paths:
*
* 1. There are available connections to all nodes but they're all bad. This path is inline so
* it then schedules onto the reactor to finish.
* 2. All nodes are bad but some needed new connections. The reaction to the new connection
* needs to be scheduled onto the reactor.
* 3. The timer in onAcquireConn() fires and the operation times out. ASIO timers run on the
* reactor.
* 4. AsyncDBClient::runCommandRequest() concludes. This path is sadly indeterminate since
* early failure can still be inline. The future chain is thenRunOn() either the baton or
* the reactor.
*
* The important bits to remember here:
* - onFinish() is out-of-line
* - Stay inline as long as feasible until onAcquireConn()---i.e. until network operations
* - Baton execution *cannot* be relied upon at least until onAcquireConn()
* - Connection failure and command failure are related but distinct
*/
// When our command finishes, run onFinish
std::move(future).getAsync([this, cmdState = cmdState, onFinish = std::move(onFinish)](
StatusWith<RemoteCommandOnAnyResponse> swr) {
invariant(swr.isOK());
auto rs = std::move(swr.getValue());
LOGV2_DEBUG(22597,
2,
"Request {cmdState_requestOnAny_id} finished with response: "
"{rs_isOK_rs_data_rs_status_toString}",
"cmdState_requestOnAny_id"_attr = cmdState->requestOnAny.id,
"rs_isOK_rs_data_rs_status_toString"_attr =
redact(rs.isOK() ? rs.data.toString() : rs.status.toString()));
onFinish(std::move(rs));
});
if (MONGO_unlikely(networkInterfaceDiscardCommandsBeforeAcquireConn.shouldFail())) {
LOGV2(22598, "Discarding command due to failpoint before acquireConn");
return Status::OK();
}
auto requestState = std::make_shared<RequestState>(cmdState);
cmdState->requestStatePtr = requestState;
// Attempt to get a connection to every target host
for (size_t idx = 0; idx < request.target.size() && !requestState->connFinishLine.isReady();
++idx) {
auto connFuture = _pool->get(request.target[idx], request.sslMode, request.timeout);
if (connFuture.isReady()) {
requestState->trySend(std::move(connFuture).getNoThrow(), idx);
continue;
}
// For every connection future we didn't have immediately ready, schedule
std::move(connFuture).thenRunOn(_reactor).getAsync([requestState, idx](auto swConn) {
requestState->trySend(std::move(swConn), idx);
});
}
return Status::OK();
}
Future<RemoteCommandResponse> NetworkInterfaceTL::CommandState::sendRequest() {
auto requestState = requestStatePtr.lock();
invariant(requestState);
return makeReadyFutureWith([this, requestState] {
setTimer();
return requestState->client()->runCommandRequest(*requestState->request, baton);
})
.then([this, requestState](RemoteCommandResponse response) {
doMetadataHook(RemoteCommandOnAnyResponse(requestState->host, response));
return response;
});
}
void NetworkInterfaceTL::CommandState::doMetadataHook(const RemoteCommandOnAnyResponse& response) {
if (auto& hook = interface->_metadataHook; hook && !finishLine.isReady()) {
invariant(response.target);
uassertStatusOK(
hook->readReplyMetadata(nullptr, response.target->toString(), response.data));
}
}
void NetworkInterfaceTL::RequestState::trySend(StatusWith<ConnectionPool::ConnectionHandle> swConn,
size_t idx) noexcept {
// Our connection wasn't any good
if (!swConn.isOK()) {
if (!connFinishLine.arriveWeakly()) {
// There are others!
return;
}
// We're the last one, set the promise if it hasn't already been set via cancel or timeout
if (cmdState->finishLine.arriveStrongly()) {
auto& reactor = interface()->_reactor;
if (reactor->onReactorThread()) {
cmdState->promise.setError(swConn.getStatus());
} else {
ExecutorFuture<void>(reactor, swConn.getStatus()).getAsync([this](Status status) {
cmdState->promise.setError(std::move(status));
});
}
}
return;
}
// Our command has already been attempted or satisfied
if (!connFinishLine.arriveStrongly() || cmdState->finishLine.isReady()) {
swConn.getValue()->indicateSuccess();
return;
}
// We have a connection and the command hasn't already been attempted
request.emplace(cmdState->requestOnAny, idx);
host = cmdState->requestOnAny.target[idx];
conn = std::move(swConn.getValue());
networkInterfaceDiscardCommandsAfterAcquireConn.pauseWhileSet();
if (auto counters = interface()->_counters) {
counters->recordSent();
}
resolve(cmdState->sendRequest());
}
void NetworkInterfaceTL::RequestState::resolve(Future<RemoteCommandResponse> future) noexcept {
auto& reactor = interface()->_reactor;
auto& baton = cmdState->baton;
// Convert the RemoteCommandResponse to a RemoteCommandOnAnyResponse and wrap any error
auto anyFuture =
std::move(future)
.then([this, anchor = shared_from_this()](RemoteCommandResponse response) {
// The RCRq ran successfully, wrap the result with the host in question
return RemoteCommandOnAnyResponse(host, std::move(response));
})
.onError([this, anchor = shared_from_this()](Status error) {
// The RCRq failed, wrap the error into a RCRsp with the host and duration
// The TransportLayer has, for historical reasons returned
// SocketException for network errors, but sharding assumes
// HostUnreachable on network errors.
if (error == ErrorCodes::SocketException) {
error = Status(ErrorCodes::HostUnreachable, error.reason());
}
return RemoteCommandOnAnyResponse(host, std::move(error), stopwatch.elapsed());
});
if (baton) {
// If we have a baton then use it for the promise and then switch to the reactor to return
// our connection.
std::move(anyFuture)
.thenRunOn(baton)
.onCompletion([ this, anchor = shared_from_this() ](auto swr) noexcept {
auto response = uassertStatusOK(swr);
auto status = swr.getValue().status;
if (cmdState->finishLine.arriveStrongly()) {
cmdState->promise.emplaceValue(std::move(response));
}
return status;
})
.thenRunOn(reactor)
.getAsync(
[this, anchor = shared_from_this()](Status status) { returnConnection(status); });
} else {
// If we do not have a baton, then we can fulfill the promise and return our connection in
// the same callback
std::move(anyFuture).thenRunOn(reactor).getAsync(
[ this, anchor = shared_from_this() ](auto swr) noexcept {
auto response = uassertStatusOK(swr);
auto status = response.status;
ON_BLOCK_EXIT([&] { returnConnection(status); });
if (!cmdState->finishLine.arriveStrongly()) {
return;
}
cmdState->promise.emplaceValue(std::move(response));
});
}
}
void NetworkInterfaceTL::cancelCommand(const TaskExecutor::CallbackHandle& cbHandle,
const BatonHandle&) {
stdx::unique_lock<Latch> lk(_inProgressMutex);
auto it = _inProgress.find(cbHandle);
if (it == _inProgress.end()) {
return;
}
auto state = it->second.lock();
if (!state) {
return;
}
_inProgress.erase(it);
lk.unlock();
if (!state->finishLine.arriveStrongly()) {
// If we didn't cross the command finishLine first, the promise is already fulfilled
return;
}
// Satisfy the promise locally
LOGV2_DEBUG(22599,
2,
"Canceling operation; original request was: {state_requestOnAny}",
"state_requestOnAny"_attr = redact(state->requestOnAny.toString()));
state->promise.setError({ErrorCodes::CallbackCanceled,
str::stream() << "Command canceled; original request was: "
<< redact(state->requestOnAny.toString())});
}
Status NetworkInterfaceTL::schedule(unique_function<void(Status)> action) {
if (inShutdown()) {
return {ErrorCodes::ShutdownInProgress, "NetworkInterface shutdown in progress"};
}
_reactor->schedule([action = std::move(action)](auto status) { action(status); });
return Status::OK();
}
Status NetworkInterfaceTL::setAlarm(const TaskExecutor::CallbackHandle& cbHandle,
Date_t when,
unique_function<void(Status)> action) {
if (inShutdown()) {
return {ErrorCodes::ShutdownInProgress, "NetworkInterface shutdown in progress"};
}
if (when <= now()) {
_reactor->schedule([action = std::move(action)](auto status) { action(status); });
return Status::OK();
}
auto pf = makePromiseFuture<void>();
std::move(pf.future).getAsync(std::move(action));
auto alarmState =
std::make_shared<AlarmState>(when, cbHandle, _reactor->makeTimer(), std::move(pf.promise));
{
stdx::lock_guard<Latch> lk(_inProgressMutex);
// If a user has already scheduled an alarm with a handle, make sure they intentionally
// override it by canceling and setting a new one.
auto alarmPair = std::make_pair(cbHandle, std::shared_ptr<AlarmState>(alarmState));
auto&& [_, wasInserted] = _inProgressAlarms.insert(std::move(alarmPair));
invariant(wasInserted);
}
alarmState->timer->waitUntil(alarmState->when, nullptr)
.getAsync([this, state = std::move(alarmState)](Status status) mutable {
_answerAlarm(status, state);
});
return Status::OK();
}
void NetworkInterfaceTL::cancelAlarm(const TaskExecutor::CallbackHandle& cbHandle) {
stdx::unique_lock<Latch> lk(_inProgressMutex);
auto iter = _inProgressAlarms.find(cbHandle);
if (iter == _inProgressAlarms.end()) {
return;
}
auto alarmState = std::move(iter->second);
_inProgressAlarms.erase(iter);
lk.unlock();
alarmState->timer->cancel();
alarmState->promise.setError(Status(ErrorCodes::CallbackCanceled, "Alarm cancelled"));
}
void NetworkInterfaceTL::_cancelAllAlarms() {
auto alarms = [&] {
stdx::unique_lock<Latch> lk(_inProgressMutex);
return std::exchange(_inProgressAlarms, {});
}();
for (auto&& [cbHandle, state] : alarms) {
state->timer->cancel();
state->promise.setError(Status(ErrorCodes::CallbackCanceled, "Alarm cancelled"));
}
}
void NetworkInterfaceTL::_answerAlarm(Status status, std::shared_ptr<AlarmState> state) {
// Since the lock is released before canceling the timer, this thread can win the race with
// cancelAlarm(). Thus if status is CallbackCanceled, then this alarm is already removed from
// _inProgressAlarms.
if (status == ErrorCodes::CallbackCanceled) {
return;
}
// transport::Reactor timers do not involve spurious wake ups, however, this check is nearly
// free and allows us to be resilient to a world where timers impls do have spurious wake ups.
auto currentTime = now();
if (status.isOK() && currentTime < state->when) {
LOGV2_DEBUG(22600,
2,
"Alarm returned early. Expected at: {state_when}, fired at: {currentTime}",
"state_when"_attr = state->when,
"currentTime"_attr = currentTime);
state->timer->waitUntil(state->when, nullptr)
.getAsync([this, state = std::move(state)](Status status) mutable {
_answerAlarm(status, state);
});
return;
}
// Erase the AlarmState from the map.
{
stdx::lock_guard<Latch> lk(_inProgressMutex);
auto iter = _inProgressAlarms.find(state->cbHandle);
if (iter == _inProgressAlarms.end()) {
return;
}
_inProgressAlarms.erase(iter);
}
// A not OK status here means the timer experienced a system error.
// It is not reasonable to complete the promise on a reactor thread because there is likely no
// properly functioning reactor.
if (!status.isOK()) {
state->promise.setError(status);
return;
}
// Fulfill the promise on a reactor thread
_reactor->schedule([state](auto status) {
if (status.isOK()) {
state->promise.emplaceValue();
} else {
state->promise.setError(status);
}
});
}
bool NetworkInterfaceTL::onNetworkThread() {
return _reactor->onReactorThread();
}
void NetworkInterfaceTL::dropConnections(const HostAndPort& hostAndPort) {
_pool->dropConnections(hostAndPort);
}
} // namespace executor
} // namespace mongo
|