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
|
/*
* Copyright (C) 2021 Apple Inc. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include <wtf/SuspendableWorkQueue.h>
#include <wtf/Logging.h>
namespace WTF {
Ref<SuspendableWorkQueue> SuspendableWorkQueue::create(ASCIILiteral name, WorkQueue::QOS qos, ShouldLog shouldLog)
{
return adoptRef(*new SuspendableWorkQueue(name, qos, shouldLog));
}
SuspendableWorkQueue::SuspendableWorkQueue(ASCIILiteral name, QOS qos, ShouldLog shouldLog)
: WorkQueue(name, qos)
, m_shouldLog(shouldLog == ShouldLog::Yes)
{
ASSERT(isMainThread());
}
ASCIILiteral SuspendableWorkQueue::stateString(State state)
{
switch (state) {
case State::Running:
return "Running"_s;
case State::WillSuspend:
return "WillSuspend"_s;
case State::Suspended:
return "Suspended"_s;
}
ASSERT_NOT_REACHED();
return { };
}
void SuspendableWorkQueue::suspend(Function<void()>&& suspendFunction, CompletionHandler<void()>&& completionHandler)
{
ASSERT(isMainThread());
Locker suspensionLocker { m_suspensionLock };
RELEASE_LOG_IF(m_shouldLog, SuspendableWorkQueue, "%p - SuspendableWorkQueue::suspend current state %" PUBLIC_LOG_STRING, this, stateString(m_state).characters());
if (m_state == State::Suspended)
return completionHandler();
// Last suspend function will be the one that is used.
m_suspendFunction = WTFMove(suspendFunction);
m_suspensionCompletionHandlers.append(WTFMove(completionHandler));
if (m_state == State::WillSuspend)
return;
m_state = State::WillSuspend;
// Make sure queue will be suspended when there is no task scheduled on the queue.
WorkQueue::dispatch([protectedThis = Ref { *this }] {
protectedThis->suspendIfNeeded();
});
}
void SuspendableWorkQueue::resume()
{
ASSERT(isMainThread());
Locker suspensionLocker { m_suspensionLock };
RELEASE_LOG_IF(m_shouldLog, SuspendableWorkQueue, "%p - SuspendableWorkQueue::resume current state %" PUBLIC_LOG_STRING, this, stateString(m_state).characters());
if (m_state == State::Running)
return;
if (m_state == State::Suspended)
m_suspensionCondition.notifyOne();
m_state = State::Running;
}
void SuspendableWorkQueue::dispatch(Function<void()>&& function)
{
RELEASE_ASSERT(function);
WorkQueue::dispatch([protectedThis = Ref { *this }, function = WTFMove(function)] {
protectedThis->suspendIfNeeded();
function();
});
}
void SuspendableWorkQueue::dispatchAfter(Seconds seconds, Function<void()>&& function)
{
RELEASE_ASSERT(function);
WorkQueue::dispatchAfter(seconds, [protectedThis = Ref { *this }, function = WTFMove(function)] {
protectedThis->suspendIfNeeded();
function();
});
}
void SuspendableWorkQueue::dispatchSync(Function<void()>&& function)
{
// This function should be called only when queue is not about to be suspended,
// otherwise thread may be blocked.
if (isMainThread()) {
Locker suspensionLocker { m_suspensionLock };
RELEASE_ASSERT(m_state == State::Running);
}
WorkQueue::dispatchSync(WTFMove(function));
}
void SuspendableWorkQueue::invokeAllSuspensionCompletionHandlers()
{
ASSERT(!isMainThread());
if (m_suspensionCompletionHandlers.isEmpty())
return;
callOnMainThread([completionHandlers = std::exchange(m_suspensionCompletionHandlers, { })]() mutable {
for (auto& completionHandler : completionHandlers) {
if (completionHandler)
completionHandler();
}
});
}
void SuspendableWorkQueue::suspendIfNeeded()
{
ASSERT(!isMainThread());
Locker suspensionLocker { m_suspensionLock };
auto suspendFunction = std::exchange(m_suspendFunction, { });
if (m_state != State::WillSuspend) {
// If state is suspended, we should not reach here.
RELEASE_LOG_ERROR_IF(m_shouldLog && m_state == State::Suspended, SuspendableWorkQueue, "%p - SuspendableWorkQueue::suspendIfNeeded current state Suspended", this);
return;
}
RELEASE_LOG_IF(m_shouldLog, SuspendableWorkQueue, "%p - SuspendableWorkQueue::suspendIfNeeded set state to Suspended, will begin suspension", this);
m_state = State::Suspended;
suspendFunction();
invokeAllSuspensionCompletionHandlers();
while (m_state == State::Suspended)
m_suspensionCondition.wait(m_suspensionLock);
RELEASE_LOG_IF(m_shouldLog, SuspendableWorkQueue, "%p - SuspendableWorkQueue::suspendIfNeeded end suspension", this);
}
} // namespace WTF
|
