Use WordLock instead of std::mutex for Threading
[WebKit-https.git] / Source / WTF / wtf / Threading.h
1 /*
2  * Copyright (C) 2007-2018 Apple Inc. All rights reserved.
3  * Copyright (C) 2007 Justin Haygood <jhaygood@reaktix.com>
4  * Copyright (C) 2017 Yusuke Suzuki <utatane.tea@gmail.com>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1.  Redistributions of source code must retain the above copyright
11  *     notice, this list of conditions and the following disclaimer. 
12  * 2.  Redistributions in binary form must reproduce the above copyright
13  *     notice, this list of conditions and the following disclaimer in the
14  *     documentation and/or other materials provided with the distribution. 
15  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
16  *     its contributors may be used to endorse or promote products derived
17  *     from this software without specific prior written permission. 
18  *
19  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef Threading_h
32 #define Threading_h
33
34 #include <mutex>
35 #include <stdint.h>
36 #include <wtf/Atomics.h>
37 #include <wtf/Expected.h>
38 #include <wtf/FastTLS.h>
39 #include <wtf/Function.h>
40 #include <wtf/PlatformRegisters.h>
41 #include <wtf/Ref.h>
42 #include <wtf/RefPtr.h>
43 #include <wtf/StackBounds.h>
44 #include <wtf/StackStats.h>
45 #include <wtf/ThreadSafeRefCounted.h>
46 #include <wtf/ThreadSpecific.h>
47 #include <wtf/Vector.h>
48 #include <wtf/WordLock.h>
49
50 #if USE(PTHREADS) && !OS(DARWIN)
51 #include <signal.h>
52 #endif
53
54 namespace WTF {
55
56 class AbstractLocker;
57 class AtomicStringTable;
58 class ThreadMessageData;
59
60 enum class ThreadGroupAddResult;
61
62 class ThreadGroup;
63 class PrintStream;
64
65 // This function can be called from any threads.
66 WTF_EXPORT_PRIVATE void initializeThreading();
67
68 // FIXME: The following functions remain because they are used from WebKit Windows support library,
69 // WebKitQuartzCoreAdditions.dll. When updating the support library, we should use new API instead
70 // and the following workaound should be removed. And new code should not use the following APIs.
71 // Remove this workaround code when <rdar://problem/31793213> is fixed.
72 #if OS(WINDOWS)
73 WTF_EXPORT_PRIVATE ThreadIdentifier createThread(ThreadFunction, void*, const char* threadName);
74 WTF_EXPORT_PRIVATE int waitForThreadCompletion(ThreadIdentifier);
75 #endif
76
77 class Thread : public ThreadSafeRefCounted<Thread> {
78 public:
79     friend class ThreadGroup;
80     friend class AtomicStringTable;
81     friend WTF_EXPORT_PRIVATE void initializeThreading();
82 #if OS(WINDOWS)
83     friend WTF_EXPORT_PRIVATE int waitForThreadCompletion(ThreadIdentifier);
84 #endif
85
86     WTF_EXPORT_PRIVATE ~Thread();
87
88     // Returns nullptr if thread creation failed.
89     // The thread name must be a literal since on some platforms it's passed in to the thread.
90     WTF_EXPORT_PRIVATE static Ref<Thread> create(const char* threadName, Function<void()>&&);
91
92     // Returns Thread object.
93     static Thread& current();
94
95 #if OS(WINDOWS)
96     // Returns ThreadIdentifier directly. It is useful if the user only cares about identity
97     // of threads. At that time, users should know that holding this ThreadIdentifier does not ensure
98     // that the thread information is alive. While Thread::current() is not safe if it is called
99     // from the destructor of the other TLS data, currentID() always returns meaningful thread ID.
100     WTF_EXPORT_PRIVATE static ThreadIdentifier currentID();
101
102     ThreadIdentifier id() const { return m_id; }
103 #endif
104
105     WTF_EXPORT_PRIVATE void changePriority(int);
106     WTF_EXPORT_PRIVATE int waitForCompletion();
107     WTF_EXPORT_PRIVATE void detach();
108
109 #if OS(DARWIN)
110     using PlatformSuspendError = kern_return_t;
111 #elif USE(PTHREADS)
112     using PlatformSuspendError = int;
113 #elif OS(WINDOWS)
114     using PlatformSuspendError = DWORD;
115 #endif
116
117     WTF_EXPORT_PRIVATE Expected<void, PlatformSuspendError> suspend();
118     WTF_EXPORT_PRIVATE void resume();
119     WTF_EXPORT_PRIVATE size_t getRegisters(PlatformRegisters&);
120
121 #if USE(PTHREADS)
122     WTF_EXPORT_PRIVATE bool signal(int signalNumber);
123 #endif
124
125     // Mark the current thread as requiring UI responsiveness.
126     // relativePriority is a value in the range [-15, 0] where a lower value indicates a lower priority.
127     WTF_EXPORT_PRIVATE static void setCurrentThreadIsUserInteractive(int relativePriority = 0);
128     WTF_EXPORT_PRIVATE static void setCurrentThreadIsUserInitiated(int relativePriority = 0);
129
130 #if HAVE(QOS_CLASSES)
131     WTF_EXPORT_PRIVATE static void setGlobalMaxQOSClass(qos_class_t);
132     WTF_EXPORT_PRIVATE static qos_class_t adjustedQOSClass(qos_class_t);
133 #endif
134
135     // Called in the thread during initialization.
136     // Helpful for platforms where the thread name must be set from within the thread.
137     static void initializeCurrentThreadInternal(const char* threadName);
138     static void initializeCurrentThreadEvenIfNonWTFCreated();
139     
140     WTF_EXPORT_PRIVATE static const unsigned lockSpinLimit;
141     WTF_EXPORT_PRIVATE static void yield();
142
143     WTF_EXPORT_PRIVATE void dump(PrintStream& out) const;
144
145     static void initializePlatformThreading();
146
147     const StackBounds& stack() const
148     {
149         return m_stack;
150     }
151
152     AtomicStringTable* atomicStringTable()
153     {
154         return m_currentAtomicStringTable;
155     }
156
157     AtomicStringTable* setCurrentAtomicStringTable(AtomicStringTable* atomicStringTable)
158     {
159         AtomicStringTable* oldAtomicStringTable = m_currentAtomicStringTable;
160         m_currentAtomicStringTable = atomicStringTable;
161         return oldAtomicStringTable;
162     }
163
164 #if ENABLE(STACK_STATS)
165     StackStats::PerThreadStats& stackStats()
166     {
167         return m_stackStats;
168     }
169 #endif
170
171     void* savedStackPointerAtVMEntry()
172     {
173         return m_savedStackPointerAtVMEntry;
174     }
175
176     void setSavedStackPointerAtVMEntry(void* stackPointerAtVMEntry)
177     {
178         m_savedStackPointerAtVMEntry = stackPointerAtVMEntry;
179     }
180
181     void* savedLastStackTop()
182     {
183         return m_savedLastStackTop;
184     }
185
186     void setSavedLastStackTop(void* lastStackTop)
187     {
188         m_savedLastStackTop = lastStackTop;
189     }
190
191 #if OS(DARWIN)
192     mach_port_t machThread() { return m_platformThread; }
193 #endif
194
195     struct NewThreadContext;
196     static void entryPoint(NewThreadContext*);
197 protected:
198     Thread() = default;
199
200     void initializeInThread();
201
202     // Internal platform-specific Thread establishment implementation.
203     bool establishHandle(NewThreadContext*);
204
205 #if USE(PTHREADS)
206     void establishPlatformSpecificHandle(PlatformThreadHandle);
207 #else
208     void establishPlatformSpecificHandle(PlatformThreadHandle, ThreadIdentifier);
209 #endif
210
211 #if USE(PTHREADS) && !OS(DARWIN)
212     static void signalHandlerSuspendResume(int, siginfo_t*, void* ucontext);
213 #endif
214
215     static const char* normalizeThreadName(const char* threadName);
216
217     enum JoinableState : uint8_t {
218         // The default thread state. The thread can be joined on.
219         Joinable,
220
221         // Somebody waited on this thread to exit and this thread finally exited. This state is here because there can be a
222         // period of time between when the thread exits (which causes pthread_join to return and the remainder of waitOnThreadCompletion to run)
223         // and when threadDidExit is called. We need threadDidExit to take charge and delete the thread data since there's
224         // nobody else to pick up the slack in this case (since waitOnThreadCompletion has already returned).
225         Joined,
226
227         // The thread has been detached and can no longer be joined on. At this point, the thread must take care of cleaning up after itself.
228         Detached,
229     };
230
231     JoinableState joinableState() { return m_joinableState; }
232     void didBecomeDetached() { m_joinableState = Detached; }
233     void didExit();
234     void didJoin() { m_joinableState = Joined; }
235     bool hasExited() { return m_didExit; }
236
237     // These functions are only called from ThreadGroup.
238     ThreadGroupAddResult addToThreadGroup(const AbstractLocker& threadGroupLocker, ThreadGroup&);
239     void removeFromThreadGroup(const AbstractLocker& threadGroupLocker, ThreadGroup&);
240
241     // The Thread instance is ref'ed and held in thread-specific storage. It will be deref'ed by destructTLS at thread destruction time.
242     // For pthread, it employs pthreads-specific 2-pass destruction to reliably remove Thread.
243     // For Windows, we use thread_local to defer thread TLS destruction. It assumes regular ThreadSpecific
244     // types don't use multiple-pass destruction.
245
246 #if !HAVE(FAST_TLS)
247     static WTF_EXPORT_PRIVATE ThreadSpecificKey s_key;
248     // One time initialization for this class as a whole.
249     // This method must be called before initializeTLS() and it is not thread-safe.
250     static void initializeTLSKey();
251 #endif
252
253     // Creates and puts an instance of Thread into thread-specific storage.
254     static Thread& initializeTLS(Ref<Thread>&&);
255     WTF_EXPORT_PRIVATE static Thread& initializeCurrentTLS();
256
257     // Returns nullptr if thread-specific storage was not initialized.
258     static Thread* currentMayBeNull();
259
260 #if OS(WINDOWS)
261     WTF_EXPORT_PRIVATE static Thread* currentDying();
262     static RefPtr<Thread> get(ThreadIdentifier);
263 #endif
264
265     // This thread-specific destructor is called 2 times when thread terminates:
266     // - first, when all the other thread-specific destructors are called, it simply remembers it was 'destroyed once'
267     // and (1) re-sets itself into the thread-specific slot or (2) constructs thread local value to call it again later.
268     // - second, after all thread-specific destructors were invoked, it gets called again - this time, we remove the
269     // Thread from the threadMap, completing the cleanup.
270     static void THREAD_SPECIFIC_CALL destructTLS(void* data);
271
272     JoinableState m_joinableState { Joinable };
273     bool m_isShuttingDown { false };
274     bool m_didExit { false };
275     bool m_isDestroyedOnce { false };
276
277     // Lock & ParkingLot rely on ThreadSpecific. But Thread object can be destroyed even after ThreadSpecific things are destroyed.
278     // Use WordLock since WordLock does not depend on ThreadSpecific and this "Thread".
279     WordLock m_mutex;
280     StackBounds m_stack { StackBounds::emptyBounds() };
281     Vector<std::weak_ptr<ThreadGroup>> m_threadGroups;
282     PlatformThreadHandle m_handle;
283 #if OS(WINDOWS)
284     ThreadIdentifier m_id { 0 };
285 #elif OS(DARWIN)
286     mach_port_t m_platformThread { MACH_PORT_NULL };
287 #elif USE(PTHREADS)
288     PlatformRegisters* m_platformRegisters { nullptr };
289     unsigned m_suspendCount { 0 };
290 #endif
291
292     AtomicStringTable* m_currentAtomicStringTable { nullptr };
293     AtomicStringTable* m_defaultAtomicStringTable { nullptr };
294
295 #if ENABLE(STACK_STATS)
296     StackStats::PerThreadStats m_stackStats;
297 #endif
298     void* m_savedStackPointerAtVMEntry { nullptr };
299     void* m_savedLastStackTop;
300 public:
301     void* m_apiData { nullptr };
302 };
303
304 inline Thread* Thread::currentMayBeNull()
305 {
306 #if !HAVE(FAST_TLS)
307     ASSERT(s_key != InvalidThreadSpecificKey);
308     return static_cast<Thread*>(threadSpecificGet(s_key));
309 #else
310     return static_cast<Thread*>(_pthread_getspecific_direct(WTF_THREAD_DATA_KEY));
311 #endif
312 }
313
314 inline Thread& Thread::current()
315 {
316     // WRT WebCore:
317     //    Thread::current() is used on main thread before it could possibly be used
318     //    on secondary ones, so there is no need for synchronization here.
319     // WRT JavaScriptCore:
320     //    Thread::initializeTLSKey() is initially called from initializeThreading(), ensuring
321     //    this is initially called in a std::call_once locked context.
322 #if !HAVE(FAST_TLS)
323     if (UNLIKELY(Thread::s_key == InvalidThreadSpecificKey))
324         WTF::initializeThreading();
325 #endif
326     if (auto* thread = currentMayBeNull())
327         return *thread;
328 #if OS(WINDOWS)
329     if (auto* thread = currentDying())
330         return *thread;
331 #endif
332     return initializeCurrentTLS();
333 }
334
335 } // namespace WTF
336
337 using WTF::Thread;
338
339 #if OS(WINDOWS)
340 using WTF::ThreadIdentifier;
341 using WTF::createThread;
342 using WTF::waitForThreadCompletion;
343 #endif
344
345 #endif // Threading_h