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
|
/**
* 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.
*/
#include "mongo/platform/basic.h"
#include "mongo/base/checked_cast.h"
#include "mongo/base/init.h"
#include "mongo/base/status.h"
#include "mongo/executor/network_interface.h"
#include "mongo/executor/network_interface_mock.h"
#include "mongo/executor/task_executor_test_common.h"
#include "mongo/executor/task_executor_test_fixture.h"
#include "mongo/executor/thread_pool_mock.h"
#include "mongo/executor/thread_pool_task_executor.h"
#include "mongo/executor/thread_pool_task_executor_test_fixture.h"
#include "mongo/stdx/memory.h"
#include "mongo/unittest/barrier.h"
#include "mongo/unittest/unittest.h"
#include "mongo/util/fail_point_service.h"
namespace mongo {
namespace executor {
namespace {
MONGO_INITIALIZER(ThreadPoolExecutorCommonTests)(InitializerContext*) {
addTestsForExecutor("ThreadPoolExecutorCommon", [](std::unique_ptr<NetworkInterfaceMock> net) {
return makeThreadPoolTestExecutor(std::move(net));
});
return Status::OK();
}
TEST_F(ThreadPoolExecutorTest, TimelyCancelationOfScheduleWorkAt) {
auto net = getNet();
auto& executor = getExecutor();
launchExecutorThread();
auto status1 = getDetectableErrorStatus();
const auto now = net->now();
const auto cb1 = unittest::assertGet(executor.scheduleWorkAt(
now + Milliseconds(5000),
[&](const TaskExecutor::CallbackArgs& cbData) { status1 = cbData.status; }));
const auto startTime = net->now();
net->enterNetwork();
net->runUntil(startTime + Milliseconds(200));
net->exitNetwork();
executor.cancel(cb1);
executor.wait(cb1);
ASSERT_EQUALS(ErrorCodes::CallbackCanceled, status1);
ASSERT_EQUALS(startTime + Milliseconds(200), net->now());
}
bool sharedCallbackStateDestroyed = false;
class SharedCallbackState {
SharedCallbackState(const SharedCallbackState&) = delete;
SharedCallbackState& operator=(const SharedCallbackState&) = delete;
public:
SharedCallbackState() {}
~SharedCallbackState() {
sharedCallbackStateDestroyed = true;
}
};
TEST_F(ThreadPoolExecutorTest,
ExecutorResetsCallbackFunctionInCallbackStateUponReturnFromCallbackFunction) {
auto net = getNet();
auto& executor = getExecutor();
launchExecutorThread();
auto sharedCallbackData = std::make_shared<SharedCallbackState>();
auto callbackInvoked = false;
const auto when = net->now() + Milliseconds(5000);
const auto cb1 = unittest::assertGet(executor.scheduleWorkAt(
when, [&callbackInvoked, sharedCallbackData](const executor::TaskExecutor::CallbackArgs&) {
callbackInvoked = true;
}));
sharedCallbackData.reset();
ASSERT_FALSE(sharedCallbackStateDestroyed);
net->enterNetwork();
ASSERT_EQUALS(when, net->runUntil(when));
net->exitNetwork();
executor.wait(cb1);
// Task executor should reset CallbackState::callback after running callback function.
// This ensures that we release resources associated with 'CallbackState::callback' without
// having to destroy every outstanding callback handle (which contains a shared pointer
// to ThreadPoolTaskExecutor::CallbackState).
ASSERT_TRUE(callbackInvoked);
ASSERT_TRUE(sharedCallbackStateDestroyed);
}
TEST_F(ThreadPoolExecutorTest, ShutdownAndScheduleRaceDoesNotCrash) {
// This is a regression test for SERVER-23686. It works by scheduling a work item in the
// ThreadPoolTaskExecutor that blocks waiting to be signaled by this thread. Once that work item
// is scheduled, this thread enables a FailPoint that causes future calls of
// ThreadPoolTaskExecutor::scheduleIntoPool_inlock to spin until its underlying thread pool
// shuts down, forcing the race condition described in the aforementioned server ticket. The
// failpoint ensures that this thread spins until the task executor thread begins spinning on
// the underlying pool shutting down, then this thread tells the task executor to shut
// down. Once the pool shuts down, the previously blocked scheduleIntoPool_inlock unblocks, and
// discovers the pool to be shut down. The correct behavior is for all scheduled callbacks to
// execute, and for this last callback at least to execute with CallbackCanceled as its status.
// Before the fix for SERVER-23686, this test causes an fassert failure.
unittest::Barrier barrier{2};
auto status1 = getDetectableErrorStatus();
StatusWith<TaskExecutor::CallbackHandle> cb2 = getDetectableErrorStatus();
auto status2 = getDetectableErrorStatus();
auto& executor = getExecutor();
launchExecutorThread();
ASSERT_OK(executor
.scheduleWork([&](const TaskExecutor::CallbackArgs& cbData) {
status1 = cbData.status;
if (!status1.isOK())
return;
barrier.countDownAndWait();
cb2 = cbData.executor->scheduleWork([&status2](
const TaskExecutor::CallbackArgs& cbData) { status2 = cbData.status; });
})
.getStatus());
auto fpTPTE1 =
getGlobalFailPointRegistry()->getFailPoint("scheduleIntoPoolSpinsUntilThreadPoolShutsDown");
fpTPTE1->setMode(FailPoint::alwaysOn);
barrier.countDownAndWait();
MONGO_FAIL_POINT_PAUSE_WHILE_SET((*fpTPTE1));
executor.shutdown();
executor.join();
ASSERT_OK(status1);
ASSERT_EQUALS(ErrorCodes::CallbackCanceled, status2);
}
} // namespace
} // namespace executor
} // namespace mongo
|
