Replace WTF::move with WTFMove
[WebKit-https.git] / Source / WTF / wtf / win / WorkQueueWin.cpp
1 /*
2 * Copyright (C) 2010, 2015 Apple Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23 * THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26 #include "config.h"
27 #include "WorkQueue.h"
28
29 #include <wtf/MathExtras.h>
30 #include <wtf/Threading.h>
31 #include <wtf/win/WorkItemWin.h>
32
33 namespace WTF {
34
35 void WorkQueue::handleCallback(void* context, BOOLEAN timerOrWaitFired)
36 {
37     ASSERT_ARG(context, context);
38     ASSERT_ARG(timerOrWaitFired, !timerOrWaitFired);
39
40     WorkItemWin* item = static_cast<WorkItemWin*>(context);
41     RefPtr<WorkQueue> queue = item->queue();
42
43     {
44         MutexLocker lock(queue->m_workItemQueueLock);
45         queue->m_workItemQueue.append(item);
46
47         // If no other thread is performing work, we can do it on this thread.
48         if (!queue->tryRegisterAsWorkThread()) {
49             // Some other thread is performing work. Since we hold the queue lock, we can be sure
50             // that the work thread is not exiting due to an empty queue and will process the work
51             // item we just added to it. If we weren't holding the lock we'd have to signal
52             // m_performWorkEvent to make sure the work item got picked up.
53             return;
54         }
55     }
56
57     queue->performWorkOnRegisteredWorkThread();
58 }
59
60 DWORD WorkQueue::workThreadCallback(void* context)
61 {
62     ASSERT_ARG(context, context);
63
64     WorkQueue* queue = static_cast<WorkQueue*>(context);
65
66     if (!queue->tryRegisterAsWorkThread())
67         return 0;
68
69     queue->performWorkOnRegisteredWorkThread();
70     return 0;
71 }
72
73 void WorkQueue::performWorkOnRegisteredWorkThread()
74 {
75     ASSERT(m_isWorkThreadRegistered);
76
77     m_workItemQueueLock.lock();
78
79     while (!m_workItemQueue.isEmpty()) {
80         Vector<RefPtr<WorkItemWin>> workItemQueue;
81         m_workItemQueue.swap(workItemQueue);
82
83         // Allow more work to be scheduled while we're not using the queue directly.
84         m_workItemQueueLock.unlock();
85         for (auto& workItem : workItemQueue) {
86             workItem->function()();
87             deref();
88         }
89         m_workItemQueueLock.lock();
90     }
91
92     // One invariant we maintain is that any work scheduled while a work thread is registered will
93     // be handled by that work thread. Unregister as the work thread while the queue lock is still
94     // held so that no work can be scheduled while we're still registered.
95     unregisterAsWorkThread();
96
97     m_workItemQueueLock.unlock();
98 }
99
100 void WorkQueue::platformInitialize(const char* name, Type, QOS)
101 {
102     m_isWorkThreadRegistered = 0;
103     m_timerQueue = ::CreateTimerQueue();
104     ASSERT_WITH_MESSAGE(m_timerQueue, "::CreateTimerQueue failed with error %lu", ::GetLastError());
105 }
106
107 bool WorkQueue::tryRegisterAsWorkThread()
108 {
109     LONG result = ::InterlockedCompareExchange(&m_isWorkThreadRegistered, 1, 0);
110     ASSERT(!result || result == 1);
111     return !result;
112 }
113
114 void WorkQueue::unregisterAsWorkThread()
115 {
116     LONG result = ::InterlockedCompareExchange(&m_isWorkThreadRegistered, 0, 1);
117     ASSERT_UNUSED(result, result == 1);
118 }
119
120 void WorkQueue::platformInvalidate()
121 {
122 #if !ASSERT_DISABLED
123     MutexLocker lock(m_handlesLock);
124     ASSERT(m_handles.isEmpty());
125 #endif
126
127     // FIXME: We need to ensure that any timer-queue timers that fire after this point don't try to
128     // access this WorkQueue <http://webkit.org/b/44690>.
129     ::DeleteTimerQueueEx(m_timerQueue, 0);
130 }
131
132 void WorkQueue::dispatch(std::function<void()> function)
133 {
134     MutexLocker locker(m_workItemQueueLock);
135     ref();
136     m_workItemQueue.append(WorkItemWin::create(function, this));
137
138     // Spawn a work thread to perform the work we just added. As an optimization, we avoid
139     // spawning the thread if a work thread is already registered. This prevents multiple work
140     // threads from being spawned in most cases. (Note that when a work thread has been spawned but
141     // hasn't registered itself yet, m_isWorkThreadRegistered will be false and we'll end up
142     // spawning a second work thread here. But work thread registration process will ensure that
143     // only one thread actually ends up performing work.)
144     if (!m_isWorkThreadRegistered)
145         ::QueueUserWorkItem(workThreadCallback, this, WT_EXECUTEDEFAULT);
146 }
147
148 struct TimerContext : public ThreadSafeRefCounted<TimerContext> {
149     static RefPtr<TimerContext> create() { return adoptRef(new TimerContext); }
150
151     WorkQueue* queue;
152     std::function<void()> function;
153     Mutex timerMutex;
154     HANDLE timer;
155
156 private:
157     TimerContext()
158         : queue(nullptr)
159         , timer(0)
160     {
161     }
162 };
163
164 void WorkQueue::timerCallback(void* context, BOOLEAN timerOrWaitFired)
165 {
166     ASSERT_ARG(context, context);
167     ASSERT_UNUSED(timerOrWaitFired, timerOrWaitFired);
168
169     // Balanced by leakRef in scheduleWorkAfterDelay.
170     RefPtr<TimerContext> timerContext = adoptRef(static_cast<TimerContext*>(context));
171
172     timerContext->queue->dispatch(timerContext->function);
173
174     MutexLocker lock(timerContext->timerMutex);
175     ASSERT(timerContext->timer);
176     ASSERT(timerContext->queue->m_timerQueue);
177     if (!::DeleteTimerQueueTimer(timerContext->queue->m_timerQueue, timerContext->timer, 0)) {
178         // Getting ERROR_IO_PENDING here means that the timer will be destroyed once the callback is done executing.
179         ASSERT_WITH_MESSAGE(::GetLastError() == ERROR_IO_PENDING, "::DeleteTimerQueueTimer failed with error %lu", ::GetLastError());
180     }
181 }
182
183 void WorkQueue::dispatchAfter(std::chrono::nanoseconds duration, std::function<void()> function)
184 {
185     ASSERT(m_timerQueue);
186     ref();
187
188     RefPtr<TimerContext> context = TimerContext::create();
189     context->queue = this;
190     context->function = function;
191
192     {
193         // The timer callback could fire before ::CreateTimerQueueTimer even returns, so we protect
194         // context->timer with a mutex to ensure the timer callback doesn't access it before the
195         // timer handle has been stored in it.
196         MutexLocker lock(context->timerMutex);
197
198         int64_t milliseconds = std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
199
200         // From empirical testing, we've seen CreateTimerQueueTimer() sometimes fire up to 5+ ms early.
201         // This causes havoc for clients of this code that expect to not be called back until the
202         // specified duration has expired. Other folks online have also observed some slop in the
203         // firing times of CreateTimerQuqueTimer(). From the data posted at
204         // http://omeg.pl/blog/2011/11/on-winapi-timers-and-their-resolution, it appears that the slop
205         // can be up to about 10 ms. To ensure that we don't fire the timer early, we'll tack on a
206         // slop adjustment to the duration, and we'll use double the worst amount of slop observed
207         // so far.
208         const int64_t slopAdjustment = 20;
209         if (milliseconds) 
210             milliseconds += slopAdjustment;
211
212         // Since our timer callback is quick, we can execute in the timer thread itself and avoid
213         // an extra thread switch over to a worker thread.
214         if (!::CreateTimerQueueTimer(&context->timer, m_timerQueue, timerCallback, context.get(), clampTo<DWORD>(milliseconds), 0, WT_EXECUTEINTIMERTHREAD)) {
215             ASSERT_WITH_MESSAGE(false, "::CreateTimerQueueTimer failed with error %lu", ::GetLastError());
216             return;
217         }
218     }
219
220     // The timer callback will handle destroying context.
221     context.release().leakRef();
222 }
223
224 void WorkQueue::unregisterWaitAndDestroyItemSoon(PassRefPtr<HandleWorkItem> item)
225 {
226     // We're going to make a blocking call to ::UnregisterWaitEx before closing the handle. (The
227     // blocking version of ::UnregisterWaitEx is much simpler than the non-blocking version.) If we
228     // do this on the current thread, we'll deadlock if we're currently in a callback function for
229     // the wait we're unregistering. So instead we do it asynchronously on some other worker thread.
230
231     ::QueueUserWorkItem(unregisterWaitAndDestroyItemCallback, item.leakRef(), WT_EXECUTEDEFAULT);
232 }
233
234 DWORD WINAPI WorkQueue::unregisterWaitAndDestroyItemCallback(void* context)
235 {
236     ASSERT_ARG(context, context);
237     RefPtr<HandleWorkItem> item = adoptRef(static_cast<HandleWorkItem*>(context));
238
239     // Now that we know we're not in a callback function for the wait we're unregistering, we can
240     // make a blocking call to ::UnregisterWaitEx.
241     if (!::UnregisterWaitEx(item->waitHandle(), INVALID_HANDLE_VALUE)) {
242         DWORD error = ::GetLastError();
243         ASSERT_NOT_REACHED();
244     }
245
246     return 0;
247 }
248
249 } // namespace WTF