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