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