WTF shouldn't have both Thread and ThreadIdentifier
[WebKit.git] / Source / WTF / wtf / ThreadingPthreads.cpp
1 /*
2  * Copyright (C) 2007, 2009, 2015 Apple Inc. All rights reserved.
3  * Copyright (C) 2007 Justin Haygood <jhaygood@reaktix.com>
4  * Copyright (C) 2011 Research In Motion Limited. All rights reserved.
5  * Copyright (C) 2017 Yusuke Suzuki <utatane.tea@gmail.com>
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1.  Redistributions of source code must retain the above copyright
12  *     notice, this list of conditions and the following disclaimer. 
13  * 2.  Redistributions in binary form must reproduce the above copyright
14  *     notice, this list of conditions and the following disclaimer in the
15  *     documentation and/or other materials provided with the distribution. 
16  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
17  *     its contributors may be used to endorse or promote products derived
18  *     from this software without specific prior written permission. 
19  *
20  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
21  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
24  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
27  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include "config.h"
33 #include "Threading.h"
34
35 #if USE(PTHREADS)
36
37 #include <errno.h>
38 #include <wtf/CurrentTime.h>
39 #include <wtf/DataLog.h>
40 #include <wtf/NeverDestroyed.h>
41 #include <wtf/RawPointer.h>
42 #include <wtf/StdLibExtras.h>
43 #include <wtf/ThreadGroup.h>
44 #include <wtf/ThreadingPrimitives.h>
45 #include <wtf/WordLock.h>
46
47 #if OS(LINUX)
48 #include <sys/prctl.h>
49 #endif
50
51 #if !COMPILER(MSVC)
52 #include <limits.h>
53 #include <sched.h>
54 #include <sys/time.h>
55 #endif
56
57 #if !OS(DARWIN) && OS(UNIX)
58
59 #include <semaphore.h>
60 #include <sys/mman.h>
61 #include <unistd.h>
62 #include <pthread.h>
63
64 #if HAVE(PTHREAD_NP_H)
65 #include <pthread_np.h>
66 #endif
67
68 #endif
69
70 namespace WTF {
71
72 static StaticLock globalSuspendLock;
73
74 Thread::~Thread()
75 {
76 }
77
78 #if !OS(DARWIN)
79 class Semaphore {
80     WTF_MAKE_NONCOPYABLE(Semaphore);
81     WTF_MAKE_FAST_ALLOCATED;
82 public:
83     explicit Semaphore(unsigned initialValue)
84     {
85         int sharedBetweenProcesses = 0;
86         sem_init(&m_platformSemaphore, sharedBetweenProcesses, initialValue);
87     }
88
89     ~Semaphore()
90     {
91         sem_destroy(&m_platformSemaphore);
92     }
93
94     void wait()
95     {
96         sem_wait(&m_platformSemaphore);
97     }
98
99     void post()
100     {
101         sem_post(&m_platformSemaphore);
102     }
103
104 private:
105     sem_t m_platformSemaphore;
106 };
107 static LazyNeverDestroyed<Semaphore> globalSemaphoreForSuspendResume;
108
109 // We use SIGUSR1 to suspend and resume machine threads in JavaScriptCore.
110 static constexpr const int SigThreadSuspendResume = SIGUSR1;
111 static std::atomic<Thread*> targetThread { nullptr };
112
113 #if COMPILER(GCC)
114 #pragma GCC diagnostic push
115 #pragma GCC diagnostic ignored "-Wreturn-local-addr"
116 #endif // COMPILER(GCC)
117
118 #if COMPILER(CLANG)
119 #pragma clang diagnostic push
120 #pragma clang diagnostic ignored "-Wreturn-stack-address"
121 #endif // COMPILER(CLANG)
122
123 static UNUSED_FUNCTION NEVER_INLINE void* getApproximateStackPointer()
124 {
125     volatile void* stackLocation = nullptr;
126     return &stackLocation;
127 }
128
129 #if COMPILER(GCC)
130 #pragma GCC diagnostic pop
131 #endif // COMPILER(GCC)
132
133 #if COMPILER(CLANG)
134 #pragma clang diagnostic pop
135 #endif // COMPILER(CLANG)
136
137 static UNUSED_FUNCTION bool isOnAlternativeSignalStack()
138 {
139     stack_t stack { };
140     int ret = sigaltstack(nullptr, &stack);
141     RELEASE_ASSERT(!ret);
142     return stack.ss_flags == SS_ONSTACK;
143 }
144
145 void Thread::signalHandlerSuspendResume(int, siginfo_t*, void* ucontext)
146 {
147     // Touching thread local atomic types from signal handlers is allowed.
148     Thread* thread = targetThread.load();
149
150     if (thread->m_suspended.load(std::memory_order_acquire)) {
151         // This is signal handler invocation that is intended to be used to resume sigsuspend.
152         // So this handler invocation itself should not process.
153         //
154         // When signal comes, first, the system calls signal handler. And later, sigsuspend will be resumed. Signal handler invocation always precedes.
155         // So, the problem never happens that suspended.store(true, ...) will be executed before the handler is called.
156         // http://pubs.opengroup.org/onlinepubs/009695399/functions/sigsuspend.html
157         return;
158     }
159
160     ucontext_t* userContext = static_cast<ucontext_t*>(ucontext);
161     ASSERT_WITH_MESSAGE(!isOnAlternativeSignalStack(), "Using an alternative signal stack is not supported. Consider disabling the concurrent GC.");
162
163 #if HAVE(MACHINE_CONTEXT)
164     thread->m_platformRegisters = &registersFromUContext(userContext);
165 #else
166     PlatformRegisters platformRegisters { getApproximateStackPointer() };
167     thread->m_platformRegisters = &platformRegisters;
168 #endif
169
170     // Allow suspend caller to see that this thread is suspended.
171     // sem_post is async-signal-safe function. It means that we can call this from a signal handler.
172     // http://pubs.opengroup.org/onlinepubs/009695399/functions/xsh_chap02_04.html#tag_02_04_03
173     //
174     // And sem_post emits memory barrier that ensures that PlatformRegisters are correctly saved.
175     // http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap04.html#tag_04_11
176     globalSemaphoreForSuspendResume->post();
177
178     // Reaching here, SigThreadSuspendResume is blocked in this handler (this is configured by sigaction's sa_mask).
179     // So before calling sigsuspend, SigThreadSuspendResume to this thread is deferred. This ensures that the handler is not executed recursively.
180     sigset_t blockedSignalSet;
181     sigfillset(&blockedSignalSet);
182     sigdelset(&blockedSignalSet, SigThreadSuspendResume);
183     sigsuspend(&blockedSignalSet);
184
185     thread->m_platformRegisters = nullptr;
186
187     // Allow resume caller to see that this thread is resumed.
188     globalSemaphoreForSuspendResume->post();
189 }
190
191 #endif // !OS(DARWIN)
192
193 void Thread::initializePlatformThreading()
194 {
195 #if !OS(DARWIN)
196     globalSemaphoreForSuspendResume.construct(0);
197
198     // Signal handlers are process global configuration.
199     // Intentionally block SigThreadSuspendResume in the handler.
200     // SigThreadSuspendResume will be allowed in the handler by sigsuspend.
201     struct sigaction action;
202     sigemptyset(&action.sa_mask);
203     sigaddset(&action.sa_mask, SigThreadSuspendResume);
204
205     action.sa_sigaction = &signalHandlerSuspendResume;
206     action.sa_flags = SA_RESTART | SA_SIGINFO;
207     sigaction(SigThreadSuspendResume, &action, 0);
208 #endif
209 }
210
211 void Thread::initializeCurrentThreadEvenIfNonWTFCreated()
212 {
213 #if !OS(DARWIN)
214     sigset_t mask;
215     sigemptyset(&mask);
216     sigaddset(&mask, SigThreadSuspendResume);
217     pthread_sigmask(SIG_UNBLOCK, &mask, 0);
218 #endif
219 }
220
221 static void* wtfThreadEntryPoint(void* context)
222 {
223     Thread::entryPoint(reinterpret_cast<Thread::NewThreadContext*>(context));
224     return nullptr;
225 }
226
227 bool Thread::establishHandle(NewThreadContext* context)
228 {
229     pthread_t threadHandle;
230     pthread_attr_t attr;
231     pthread_attr_init(&attr);
232 #if HAVE(QOS_CLASSES)
233     pthread_attr_set_qos_class_np(&attr, adjustedQOSClass(QOS_CLASS_USER_INITIATED), 0);
234 #endif
235     int error = pthread_create(&threadHandle, &attr, wtfThreadEntryPoint, context);
236     pthread_attr_destroy(&attr);
237     if (error) {
238         LOG_ERROR("Failed to create pthread at entry point %p with context %p", wtfThreadEntryPoint, context);
239         return false;
240     }
241     establishPlatformSpecificHandle(threadHandle);
242     return true;
243 }
244
245 void Thread::initializeCurrentThreadInternal(const char* threadName)
246 {
247 #if HAVE(PTHREAD_SETNAME_NP)
248     pthread_setname_np(normalizeThreadName(threadName));
249 #elif OS(LINUX)
250     prctl(PR_SET_NAME, normalizeThreadName(threadName));
251 #else
252     UNUSED_PARAM(threadName);
253 #endif
254     initializeCurrentThreadEvenIfNonWTFCreated();
255 }
256
257 void Thread::changePriority(int delta)
258 {
259     std::lock_guard<std::mutex> locker(m_mutex);
260
261     int policy;
262     struct sched_param param;
263
264     if (pthread_getschedparam(m_handle, &policy, &param))
265         return;
266
267     param.sched_priority += delta;
268
269     pthread_setschedparam(m_handle, policy, &param);
270 }
271
272 int Thread::waitForCompletion()
273 {
274     pthread_t handle;
275     {
276         std::lock_guard<std::mutex> locker(m_mutex);
277         handle = m_handle;
278     }
279
280     int joinResult = pthread_join(handle, 0);
281
282     if (joinResult == EDEADLK)
283         LOG_ERROR("Thread %p was found to be deadlocked trying to quit", this);
284     else if (joinResult)
285         LOG_ERROR("Thread %p was unable to be joined.\n", this);
286
287     std::lock_guard<std::mutex> locker(m_mutex);
288     ASSERT(joinableState() == Joinable);
289
290     // If the thread has already exited, then do nothing. If the thread hasn't exited yet, then just signal that we've already joined on it.
291     // In both cases, Thread::destructTLS() will take care of destroying Thread.
292     if (!hasExited())
293         didJoin();
294
295     return joinResult;
296 }
297
298 void Thread::detach()
299 {
300     std::lock_guard<std::mutex> locker(m_mutex);
301     int detachResult = pthread_detach(m_handle);
302     if (detachResult)
303         LOG_ERROR("Thread %p was unable to be detached\n", this);
304
305     if (!hasExited())
306         didBecomeDetached();
307 }
308
309 Thread& Thread::initializeCurrentTLS()
310 {
311     // Not a WTF-created thread, Thread is not established yet.
312     Ref<Thread> thread = adoptRef(*new Thread());
313     thread->establishPlatformSpecificHandle(pthread_self());
314     thread->initializeInThread();
315     initializeCurrentThreadEvenIfNonWTFCreated();
316
317     return initializeTLS(WTFMove(thread));
318 }
319
320 bool Thread::signal(int signalNumber)
321 {
322     std::lock_guard<std::mutex> locker(m_mutex);
323     if (hasExited())
324         return false;
325     int errNo = pthread_kill(m_handle, signalNumber);
326     return !errNo; // A 0 errNo means success.
327 }
328
329 auto Thread::suspend() -> Expected<void, PlatformSuspendError>
330 {
331     RELEASE_ASSERT_WITH_MESSAGE(this != &Thread::current(), "We do not support suspending the current thread itself.");
332     // During suspend, suspend or resume should not be executed from the other threads.
333     // We use global lock instead of per thread lock.
334     // Consider the following case, there are threads A and B.
335     // And A attempt to suspend B and B attempt to suspend A.
336     // A and B send signals. And later, signals are delivered to A and B.
337     // In that case, both will be suspended.
338     //
339     // And it is important to use a global lock to suspend and resume. Let's consider using per-thread lock.
340     // Your issuing thread (A) attempts to suspend the target thread (B). Then, you will suspend the thread (C) additionally.
341     // This case frequently happens if you stop threads to perform stack scanning. But thread (B) may hold the lock of thread (C).
342     // In that case, dead lock happens. Using global lock here avoids this dead lock.
343     LockHolder locker(globalSuspendLock);
344 #if OS(DARWIN)
345     kern_return_t result = thread_suspend(m_platformThread);
346     if (result != KERN_SUCCESS)
347         return makeUnexpected(result);
348     return { };
349 #else
350     if (!m_suspendCount) {
351         // Ideally, we would like to use pthread_sigqueue. It allows us to pass the argument to the signal handler.
352         // But it can be used in a few platforms, like Linux.
353         // Instead, we use Thread* stored in the thread local storage to pass it to the signal handler.
354         targetThread.store(this);
355         int result = pthread_kill(m_handle, SigThreadSuspendResume);
356         if (result)
357             return makeUnexpected(result);
358         globalSemaphoreForSuspendResume->wait();
359         // Release barrier ensures that this operation is always executed after all the above processing is done.
360         m_suspended.store(true, std::memory_order_release);
361     }
362     ++m_suspendCount;
363     return { };
364 #endif
365 }
366
367 void Thread::resume()
368 {
369     // During resume, suspend or resume should not be executed from the other threads.
370     LockHolder locker(globalSuspendLock);
371 #if OS(DARWIN)
372     thread_resume(m_platformThread);
373 #else
374     if (m_suspendCount == 1) {
375         // When allowing SigThreadSuspendResume interrupt in the signal handler by sigsuspend and SigThreadSuspendResume is actually issued,
376         // the signal handler itself will be called once again.
377         // There are several ways to distinguish the handler invocation for suspend and resume.
378         // 1. Use different signal numbers. And check the signal number in the handler.
379         // 2. Use some arguments to distinguish suspend and resume in the handler. If pthread_sigqueue can be used, we can take this.
380         // 3. Use thread local storage with atomic variables in the signal handler.
381         // In this implementaiton, we take (3). suspended flag is used to distinguish it.
382         targetThread.store(this);
383         if (pthread_kill(m_handle, SigThreadSuspendResume) == ESRCH)
384             return;
385         globalSemaphoreForSuspendResume->wait();
386         // Release barrier ensures that this operation is always executed after all the above processing is done.
387         m_suspended.store(false, std::memory_order_release);
388     }
389     --m_suspendCount;
390 #endif
391 }
392
393 #if OS(DARWIN)
394 struct ThreadStateMetadata {
395     unsigned userCount;
396     thread_state_flavor_t flavor;
397 };
398
399 static ThreadStateMetadata threadStateMetadata()
400 {
401 #if CPU(X86)
402     unsigned userCount = sizeof(PlatformRegisters) / sizeof(int);
403     thread_state_flavor_t flavor = i386_THREAD_STATE;
404 #elif CPU(X86_64)
405     unsigned userCount = x86_THREAD_STATE64_COUNT;
406     thread_state_flavor_t flavor = x86_THREAD_STATE64;
407 #elif CPU(PPC)
408     unsigned userCount = PPC_THREAD_STATE_COUNT;
409     thread_state_flavor_t flavor = PPC_THREAD_STATE;
410 #elif CPU(PPC64)
411     unsigned userCount = PPC_THREAD_STATE64_COUNT;
412     thread_state_flavor_t flavor = PPC_THREAD_STATE64;
413 #elif CPU(ARM)
414     unsigned userCount = ARM_THREAD_STATE_COUNT;
415     thread_state_flavor_t flavor = ARM_THREAD_STATE;
416 #elif CPU(ARM64)
417     unsigned userCount = ARM_THREAD_STATE64_COUNT;
418     thread_state_flavor_t flavor = ARM_THREAD_STATE64;
419 #else
420 #error Unknown Architecture
421 #endif
422     return ThreadStateMetadata { userCount, flavor };
423 }
424 #endif // OS(DARWIN)
425
426 size_t Thread::getRegisters(PlatformRegisters& registers)
427 {
428     LockHolder locker(globalSuspendLock);
429 #if OS(DARWIN)
430     auto metadata = threadStateMetadata();
431     kern_return_t result = thread_get_state(m_platformThread, metadata.flavor, (thread_state_t)&registers, &metadata.userCount);
432     if (result != KERN_SUCCESS) {
433         WTFReportFatalError(__FILE__, __LINE__, WTF_PRETTY_FUNCTION, "JavaScript garbage collection failed because thread_get_state returned an error (%d). This is probably the result of running inside Rosetta, which is not supported.", result);
434         CRASH();
435     }
436     return metadata.userCount * sizeof(uintptr_t);
437 #else
438     ASSERT_WITH_MESSAGE(m_suspendCount, "We can get registers only if the thread is suspended.");
439     ASSERT(m_platformRegisters);
440     registers = *m_platformRegisters;
441     return sizeof(PlatformRegisters);
442 #endif
443 }
444
445 void Thread::establishPlatformSpecificHandle(pthread_t handle)
446 {
447     std::lock_guard<std::mutex> locker(m_mutex);
448     m_handle = handle;
449 #if OS(DARWIN)
450     m_platformThread = pthread_mach_thread_np(handle);
451 #endif
452 }
453
454 #if !HAVE(FAST_TLS)
455 void Thread::initializeTLSKey()
456 {
457     threadSpecificKeyCreate(&s_key, destructTLS);
458 }
459 #endif
460
461 Thread& Thread::initializeTLS(Ref<Thread>&& thread)
462 {
463     // We leak the ref to keep the Thread alive while it is held in TLS. destructTLS will deref it later at thread destruction time.
464     auto& threadInTLS = thread.leakRef();
465 #if !HAVE(FAST_TLS)
466     ASSERT(s_key != InvalidThreadSpecificKey);
467     threadSpecificSet(s_key, &threadInTLS);
468 #else
469     _pthread_setspecific_direct(WTF_THREAD_DATA_KEY, &threadInTLS);
470     pthread_key_init_np(WTF_THREAD_DATA_KEY, &destructTLS);
471 #endif
472     return threadInTLS;
473 }
474
475 void Thread::destructTLS(void* data)
476 {
477     Thread* thread = static_cast<Thread*>(data);
478     ASSERT(thread);
479
480     if (thread->m_isDestroyedOnce) {
481         thread->didExit();
482         thread->deref();
483         return;
484     }
485
486     thread->m_isDestroyedOnce = true;
487     // Re-setting the value for key causes another destructTLS() call after all other thread-specific destructors were called.
488 #if !HAVE(FAST_TLS)
489     ASSERT(s_key != InvalidThreadSpecificKey);
490     threadSpecificSet(s_key, thread);
491 #else
492     _pthread_setspecific_direct(WTF_THREAD_DATA_KEY, thread);
493     pthread_key_init_np(WTF_THREAD_DATA_KEY, &destructTLS);
494 #endif
495 }
496
497 Mutex::Mutex()
498 {
499     pthread_mutexattr_t attr;
500     pthread_mutexattr_init(&attr);
501     pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_NORMAL);
502
503     int result = pthread_mutex_init(&m_mutex, &attr);
504     ASSERT_UNUSED(result, !result);
505
506     pthread_mutexattr_destroy(&attr);
507 }
508
509 Mutex::~Mutex()
510 {
511     int result = pthread_mutex_destroy(&m_mutex);
512     ASSERT_UNUSED(result, !result);
513 }
514
515 void Mutex::lock()
516 {
517     int result = pthread_mutex_lock(&m_mutex);
518     ASSERT_UNUSED(result, !result);
519 }
520
521 bool Mutex::tryLock()
522 {
523     int result = pthread_mutex_trylock(&m_mutex);
524
525     if (result == 0)
526         return true;
527     if (result == EBUSY)
528         return false;
529
530     ASSERT_NOT_REACHED();
531     return false;
532 }
533
534 void Mutex::unlock()
535 {
536     int result = pthread_mutex_unlock(&m_mutex);
537     ASSERT_UNUSED(result, !result);
538 }
539
540 ThreadCondition::ThreadCondition()
541
542     pthread_cond_init(&m_condition, NULL);
543 }
544
545 ThreadCondition::~ThreadCondition()
546 {
547     pthread_cond_destroy(&m_condition);
548 }
549     
550 void ThreadCondition::wait(Mutex& mutex)
551 {
552     int result = pthread_cond_wait(&m_condition, &mutex.impl());
553     ASSERT_UNUSED(result, !result);
554 }
555
556 bool ThreadCondition::timedWait(Mutex& mutex, double absoluteTime)
557 {
558     if (absoluteTime < currentTime())
559         return false;
560
561     if (absoluteTime > INT_MAX) {
562         wait(mutex);
563         return true;
564     }
565
566     int timeSeconds = static_cast<int>(absoluteTime);
567     int timeNanoseconds = static_cast<int>((absoluteTime - timeSeconds) * 1E9);
568
569     timespec targetTime;
570     targetTime.tv_sec = timeSeconds;
571     targetTime.tv_nsec = timeNanoseconds;
572
573     return pthread_cond_timedwait(&m_condition, &mutex.impl(), &targetTime) == 0;
574 }
575
576 void ThreadCondition::signal()
577 {
578     int result = pthread_cond_signal(&m_condition);
579     ASSERT_UNUSED(result, !result);
580 }
581
582 void ThreadCondition::broadcast()
583 {
584     int result = pthread_cond_broadcast(&m_condition);
585     ASSERT_UNUSED(result, !result);
586 }
587
588 void Thread::yield()
589 {
590     sched_yield();
591 }
592
593 } // namespace WTF
594
595 #endif // USE(PTHREADS)