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
|
/*
* Copyright (C) 2004-2025 ZNC, see the NOTICE file for details.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include <gtest/gtest.h>
#include <znc/Threads.h>
#include <sys/select.h>
class CWaitingJob : public CJob {
public:
CWaitingJob(bool& destroyed)
: m_bDestroyed(destroyed),
m_Mutex(),
m_CV(),
m_bThreadReady(false),
m_bThreadDone(false){};
~CWaitingJob() override {
EXPECT_TRUE(m_bThreadReady);
EXPECT_TRUE(m_bThreadDone);
EXPECT_FALSE(wasCancelled());
m_bDestroyed = true;
}
void signal() {
CMutexLocker locker(m_Mutex);
// Wait for the thread to run
while (!m_bThreadReady) m_CV.wait(m_Mutex);
// and signal it to exit
m_bThreadDone = true;
m_CV.notify_all();
}
void runThread() override {
CMutexLocker locker(m_Mutex);
// We are running
m_bThreadReady = true;
m_CV.notify_all();
// wait for our exit signal
while (!m_bThreadDone) m_CV.wait(m_Mutex);
}
void runMain() override {}
private:
bool& m_bDestroyed;
CMutex m_Mutex;
CConditionVariable m_CV;
bool m_bThreadReady;
bool m_bThreadDone;
};
TEST(Thread, RunJob) {
bool destroyed = false;
CWaitingJob* pJob = new CWaitingJob(destroyed);
CThreadPool::Get().addJob(pJob);
pJob->signal();
while (!destroyed) CThreadPool::Get().handlePipeReadable();
}
class CCancelJob : public CJob {
public:
CCancelJob(bool& destroyed)
: m_bDestroyed(destroyed),
m_Mutex(),
m_CVThreadReady(),
m_bThreadReady(false) {}
~CCancelJob() override {
EXPECT_TRUE(wasCancelled());
m_bDestroyed = true;
}
void wait() {
CMutexLocker locker(m_Mutex);
// Wait for the thread to run
while (!m_bThreadReady) m_CVThreadReady.wait(m_Mutex);
}
void runThread() override {
m_Mutex.lock();
// We are running, tell the main thread
m_bThreadReady = true;
m_CVThreadReady.notify_all();
// Have to unlock here so that wait() can get the mutex
m_Mutex.unlock();
while (!wasCancelled()) {
// We can't do much besides busy-looping here. If the
// job really gets cancelled while it is already
// running, the main thread is stuck in cancelJob(), so
// it cannot signal us in any way. And signaling us
// before calling cancelJob() effictively is the same
// thing as busy looping anyway. So busy looping it is.
// (Yes, CJob shouldn't be used for anything that
// requires synchronisation between threads!)
}
}
void runMain() override {}
private:
bool& m_bDestroyed;
CMutex m_Mutex;
CConditionVariable m_CVThreadReady;
bool m_bThreadReady;
};
TEST(Thread, CancelJobEarly) {
bool destroyed = false;
CCancelJob* pJob = new CCancelJob(destroyed);
CThreadPool::Get().addJob(pJob);
// Don't wait for the job to run. The idea here is that we are calling
// cancelJob() before pJob->runThread() runs, but this is a race.
CThreadPool::Get().cancelJob(pJob);
// cancelJob() should only return after successful cancellation
EXPECT_TRUE(destroyed);
}
TEST(Thread, CancelJobWhileRunning) {
bool destroyed = false;
CCancelJob* pJob = new CCancelJob(destroyed);
CThreadPool::Get().addJob(pJob);
// Wait for the job to run
pJob->wait();
CThreadPool::Get().cancelJob(pJob);
// cancelJob() should only return after successful cancellation
EXPECT_TRUE(destroyed);
}
class CEmptyJob : public CJob {
public:
CEmptyJob(bool& destroyed) : m_bDestroyed(destroyed) {}
~CEmptyJob() override {
EXPECT_TRUE(wasCancelled());
m_bDestroyed = true;
}
void runThread() override {}
void runMain() override {}
private:
bool& m_bDestroyed;
};
TEST(Thread, CancelJobWhenDone) {
bool destroyed = false;
CEmptyJob* pJob = new CEmptyJob(destroyed);
CThreadPool::Get().addJob(pJob);
// Wait for the job to finish
fd_set fds;
FD_ZERO(&fds);
FD_SET(CThreadPool::Get().getReadFD(), &fds);
EXPECT_EQ(select(1 + CThreadPool::Get().getReadFD(), &fds, nullptr,
nullptr, nullptr), 1);
// And only cancel it afterwards
CThreadPool::Get().cancelJob(pJob);
// cancelJob() should only return after successful cancellation
EXPECT_TRUE(destroyed);
}
|
