Fix a couple of compiler warnings.
[WebKit-https.git] / WebCore / platform / win / ThreadingWin.cpp
1 /*
2  * Copyright (C) 2007 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "Logging.h"
31 #include "Page.h"
32 #include "Threading.h"
33 #include <errno.h>
34 #include <windows.h>
35 #include <wtf/HashMap.h>
36
37 namespace WebCore {
38
39 typedef Vector<void(*)()> FunctionQueue;
40
41 static HWND threadingWindowHandle = 0;
42 static UINT threadingFiredMessage = 0;
43 const LPCWSTR kThreadingWindowClassName = L"ThreadingWindowClass";
44 static bool processingCustomThreadingMessage = false;
45
46 static Mutex& threadMapMutex()
47 {
48     static Mutex mutex;
49     return mutex;
50 }
51
52 static HashMap<DWORD, HANDLE>& threadMap()
53 {
54     static HashMap<DWORD, HANDLE> map;
55     return map;
56 }
57
58 static void storeThreadHandleByIdentifier(DWORD threadID, HANDLE threadHandle)
59 {
60     MutexLocker locker(threadMapMutex());
61     threadMap().add(threadID, threadHandle);
62 }
63
64 static HANDLE threadHandleForIdentifier(ThreadIdentifier id)
65 {
66     MutexLocker locker(threadMapMutex());
67     return threadMap().get(id);
68 }
69
70 static void clearThreadHandleForIdentifier(ThreadIdentifier id)
71 {
72     MutexLocker locker(threadMapMutex());
73     ASSERT(threadMap().contains(id));
74     threadMap().remove(id);
75 }
76
77 ThreadIdentifier createThread(ThreadFunction entryPoint, void* data)
78 {
79     DWORD threadIdentifier = 0;
80     ThreadIdentifier threadID = 0;
81     HANDLE hEvent = ::CreateEvent(0, FALSE, FALSE, 0);
82     HANDLE threadHandle = ::CreateThread(0, 0, (LPTHREAD_START_ROUTINE)entryPoint, data, 0, &threadIdentifier);
83     if (!threadHandle) {
84         LOG_ERROR("Failed to create thread at entry point %p with data %p", entryPoint, data);
85         return 0;
86     }
87
88     threadID = static_cast<ThreadIdentifier>(threadIdentifier);
89     storeThreadHandleByIdentifier(threadIdentifier, threadHandle);
90
91     LOG(Threading, "Created thread with thread id %u", threadID);
92     return threadID;
93 }
94
95 int waitForThreadCompletion(ThreadIdentifier threadID, void** result)
96 {
97     ASSERT(threadID);
98     
99     HANDLE threadHandle = threadHandleForIdentifier(threadID);
100     if (!threadHandle)
101         LOG_ERROR("ThreadIdentifier %u did not correspond to an active thread when trying to quit", threadID);
102  
103     DWORD joinResult = ::WaitForSingleObject(threadHandle, INFINITE);
104     if (joinResult == WAIT_FAILED)
105         LOG_ERROR("ThreadIdentifier %u was found to be deadlocked trying to quit", threadID);
106
107     ::CloseHandle(threadHandle);
108     clearThreadHandleForIdentifier(threadID);
109
110     return joinResult;
111 }
112
113 void detachThread(ThreadIdentifier threadID)
114 {
115     ASSERT(threadID);
116     
117     HANDLE threadHandle = threadHandleForIdentifier(threadID);
118     if (threadHandle)
119         ::CloseHandle(threadHandle);
120     clearThreadHandleForIdentifier(threadID);
121 }
122
123 ThreadIdentifier currentThread()
124 {
125     return static_cast<ThreadIdentifier>(::GetCurrentThreadId());
126 }
127
128 static Mutex& functionQueueMutex()
129 {
130     static Mutex staticFunctionQueueMutex;
131     return staticFunctionQueueMutex;
132 }
133
134 static FunctionQueue& functionQueue()
135 {
136     static FunctionQueue staticFunctionQueue;
137     return staticFunctionQueue;
138 }
139
140 static void callFunctionsOnMainThread()
141 {
142     FunctionQueue queueCopy;
143     {
144         MutexLocker locker(functionQueueMutex());
145         queueCopy.swap(functionQueue());
146     }
147
148     LOG(Threading, "Calling %u functions on the main thread", queueCopy.size());
149     for (unsigned i = 0; i < queueCopy.size(); ++i)
150         queueCopy[i]();
151 }
152
153 LRESULT CALLBACK ThreadingWindowWndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
154 {
155     if (message == threadingFiredMessage) {
156         processingCustomThreadingMessage = true;
157         callFunctionsOnMainThread();
158         processingCustomThreadingMessage = false;
159     } else
160         return DefWindowProc(hWnd, message, wParam, lParam);
161     return 0;
162 }
163
164 void initializeThreading()
165 {
166     if (threadingWindowHandle)
167         return;
168     
169     WNDCLASSEX wcex;
170     memset(&wcex, 0, sizeof(WNDCLASSEX));
171     wcex.cbSize = sizeof(WNDCLASSEX);
172     wcex.lpfnWndProc    = ThreadingWindowWndProc;
173     wcex.hInstance      = Page::instanceHandle();
174     wcex.lpszClassName  = kThreadingWindowClassName;
175     RegisterClassEx(&wcex);
176
177     threadingWindowHandle = CreateWindow(kThreadingWindowClassName, 0, 0,
178        CW_USEDEFAULT, 0, CW_USEDEFAULT, 0, HWND_MESSAGE, 0, Page::instanceHandle(), 0);
179     threadingFiredMessage = RegisterWindowMessage(L"com.apple.WebKit.MainThreadFired");
180 }
181     
182 void callOnMainThread(void(*function)())
183 {
184     ASSERT(function);
185     ASSERT(threadingWindowHandle);
186
187     if (processingCustomThreadingMessage)
188         LOG(Threading, "callOnMainThread() called recursively.  Beware of nested PostMessage()s");
189
190     {
191         MutexLocker locker(functionQueueMutex());
192         functionQueue().append(function);
193     }
194
195     PostMessage(threadingWindowHandle, threadingFiredMessage, 0, 0);
196 }
197
198 } // namespace WebCore