Use WordLock instead of std::mutex for Threading
[WebKit-https.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/DataLog.h>
39 #include <wtf/NeverDestroyed.h>
40 #include <wtf/RawPointer.h>
41 #include <wtf/StdLibExtras.h>
42 #include <wtf/ThreadGroup.h>
43 #include <wtf/ThreadingPrimitives.h>
44 #include <wtf/WordLock.h>
45
46 #if OS(LINUX)
47 #include <sys/prctl.h>
48 #endif
49
50 #if !COMPILER(MSVC)
51 #include <limits.h>
52 #include <sched.h>
53 #include <sys/time.h>
54 #endif
55
56 #if !OS(DARWIN) && OS(UNIX)
57
58 #include <semaphore.h>
59 #include <sys/mman.h>
60 #include <unistd.h>
61 #include <pthread.h>
62
63 #if HAVE(PTHREAD_NP_H)
64 #include <pthread_np.h>
65 #endif
66
67 #endif
68
69 namespace WTF {
70
71 static Lock globalSuspendLock;
72
73 Thread::~Thread()
74 {
75 }
76
77 #if !OS(DARWIN)
78 class Semaphore {
79     WTF_MAKE_NONCOPYABLE(Semaphore);
80     WTF_MAKE_FAST_ALLOCATED;
81 public:
82     explicit Semaphore(unsigned initialValue)
83     {
84         int sharedBetweenProcesses = 0;
85         sem_init(&m_platformSemaphore, sharedBetweenProcesses, initialValue);
86     }
87
88     ~Semaphore()
89     {
90         sem_destroy(&m_platformSemaphore);
91     }
92
93     void wait()
94     {
95         sem_wait(&m_platformSemaphore);
96     }
97
98     void post()
99     {
100         sem_post(&m_platformSemaphore);
101     }
102
103 private:
104     sem_t m_platformSemaphore;
105 };
106 static LazyNeverDestroyed<Semaphore> globalSemaphoreForSuspendResume;
107
108 // We use SIGUSR1 to suspend and resume machine threads in JavaScriptCore.
109 static constexpr const int SigThreadSuspendResume = SIGUSR1;
110 static std::atomic<Thread*> targetThread { nullptr };
111
112 #if COMPILER(GCC)
113 #pragma GCC diagnostic push
114 #pragma GCC diagnostic ignored "-Wreturn-local-addr"
115 #endif // COMPILER(GCC)
116
117 #if COMPILER(CLANG)
118 #pragma clang diagnostic push
119 #pragma clang diagnostic ignored "-Wreturn-stack-address"
120 #endif // COMPILER(CLANG)
121
122 static UNUSED_FUNCTION NEVER_INLINE void* getApproximateStackPointer()
123 {
124     volatile void* stackLocation = nullptr;
125     return &stackLocation;
126 }
127
128 #if COMPILER(GCC)
129 #pragma GCC diagnostic pop
130 #endif // COMPILER(GCC)
131
132 #if COMPILER(CLANG)
133 #pragma clang diagnostic pop
134 #endif // COMPILER(CLANG)
135
136 static UNUSED_FUNCTION bool isOnAlternativeSignalStack()
137 {
138     stack_t stack { };
139     int ret = sigaltstack(nullptr, &stack);
140     RELEASE_ASSERT(!ret);
141     return stack.ss_flags == SS_ONSTACK;
142 }
143
144 void Thread::signalHandlerSuspendResume(int, siginfo_t*, void* ucontext)
145 {
146     // Touching a global variable atomic types from signal handlers is allowed.
147     Thread* thread = targetThread.load();
148
149     if (thread->m_suspendCount) {
150         // This is signal handler invocation that is intended to be used to resume sigsuspend.
151         // So this handler invocation itself should not process.
152         //
153         // When signal comes, first, the system calls signal handler. And later, sigsuspend will be resumed. Signal handler invocation always precedes.
154         // So, the problem never happens that suspended.store(true, ...) will be executed before the handler is called.
155         // http://pubs.opengroup.org/onlinepubs/009695399/functions/sigsuspend.html
156         return;
157     }
158
159     ASSERT_WITH_MESSAGE(!isOnAlternativeSignalStack(), "Using an alternative signal stack is not supported. Consider disabling the concurrent GC.");
160
161 #if HAVE(MACHINE_CONTEXT)
162     ucontext_t* userContext = static_cast<ucontext_t*>(ucontext);
163     thread->m_platformRegisters = &registersFromUContext(userContext);
164 #else
165     UNUSED_PARAM(ucontext);
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     auto locker = holdLock(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         auto locker = holdLock(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     auto locker = holdLock(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     auto locker = holdLock(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     auto locker = holdLock(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 a global variable 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     }
360     ++m_suspendCount;
361     return { };
362 #endif
363 }
364
365 void Thread::resume()
366 {
367     // During resume, suspend or resume should not be executed from the other threads.
368     LockHolder locker(globalSuspendLock);
369 #if OS(DARWIN)
370     thread_resume(m_platformThread);
371 #else
372     if (m_suspendCount == 1) {
373         // When allowing SigThreadSuspendResume interrupt in the signal handler by sigsuspend and SigThreadSuspendResume is actually issued,
374         // the signal handler itself will be called once again.
375         // There are several ways to distinguish the handler invocation for suspend and resume.
376         // 1. Use different signal numbers. And check the signal number in the handler.
377         // 2. Use some arguments to distinguish suspend and resume in the handler. If pthread_sigqueue can be used, we can take this.
378         // 3. Use thread's flag.
379         // In this implementaiton, we take (3). m_suspendCount is used to distinguish it.
380         targetThread.store(this);
381         if (pthread_kill(m_handle, SigThreadSuspendResume) == ESRCH)
382             return;
383         globalSemaphoreForSuspendResume->wait();
384     }
385     --m_suspendCount;
386 #endif
387 }
388
389 #if OS(DARWIN)
390 struct ThreadStateMetadata {
391     unsigned userCount;
392     thread_state_flavor_t flavor;
393 };
394
395 static ThreadStateMetadata threadStateMetadata()
396 {
397 #if CPU(X86)
398     unsigned userCount = sizeof(PlatformRegisters) / sizeof(int);
399     thread_state_flavor_t flavor = i386_THREAD_STATE;
400 #elif CPU(X86_64)
401     unsigned userCount = x86_THREAD_STATE64_COUNT;
402     thread_state_flavor_t flavor = x86_THREAD_STATE64;
403 #elif CPU(PPC)
404     unsigned userCount = PPC_THREAD_STATE_COUNT;
405     thread_state_flavor_t flavor = PPC_THREAD_STATE;
406 #elif CPU(PPC64)
407     unsigned userCount = PPC_THREAD_STATE64_COUNT;
408     thread_state_flavor_t flavor = PPC_THREAD_STATE64;
409 #elif CPU(ARM)
410     unsigned userCount = ARM_THREAD_STATE_COUNT;
411     thread_state_flavor_t flavor = ARM_THREAD_STATE;
412 #elif CPU(ARM64)
413     unsigned userCount = ARM_THREAD_STATE64_COUNT;
414     thread_state_flavor_t flavor = ARM_THREAD_STATE64;
415 #else
416 #error Unknown Architecture
417 #endif
418     return ThreadStateMetadata { userCount, flavor };
419 }
420 #endif // OS(DARWIN)
421
422 size_t Thread::getRegisters(PlatformRegisters& registers)
423 {
424     LockHolder locker(globalSuspendLock);
425 #if OS(DARWIN)
426     auto metadata = threadStateMetadata();
427     kern_return_t result = thread_get_state(m_platformThread, metadata.flavor, (thread_state_t)&registers, &metadata.userCount);
428     if (result != KERN_SUCCESS) {
429         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);
430         CRASH();
431     }
432     return metadata.userCount * sizeof(uintptr_t);
433 #else
434     ASSERT_WITH_MESSAGE(m_suspendCount, "We can get registers only if the thread is suspended.");
435     ASSERT(m_platformRegisters);
436     registers = *m_platformRegisters;
437     return sizeof(PlatformRegisters);
438 #endif
439 }
440
441 void Thread::establishPlatformSpecificHandle(pthread_t handle)
442 {
443     auto locker = holdLock(m_mutex);
444     m_handle = handle;
445 #if OS(DARWIN)
446     m_platformThread = pthread_mach_thread_np(handle);
447 #endif
448 }
449
450 #if !HAVE(FAST_TLS)
451 void Thread::initializeTLSKey()
452 {
453     threadSpecificKeyCreate(&s_key, destructTLS);
454 }
455 #endif
456
457 Thread& Thread::initializeTLS(Ref<Thread>&& thread)
458 {
459     // We leak the ref to keep the Thread alive while it is held in TLS. destructTLS will deref it later at thread destruction time.
460     auto& threadInTLS = thread.leakRef();
461 #if !HAVE(FAST_TLS)
462     ASSERT(s_key != InvalidThreadSpecificKey);
463     threadSpecificSet(s_key, &threadInTLS);
464 #else
465     _pthread_setspecific_direct(WTF_THREAD_DATA_KEY, &threadInTLS);
466     pthread_key_init_np(WTF_THREAD_DATA_KEY, &destructTLS);
467 #endif
468     return threadInTLS;
469 }
470
471 void Thread::destructTLS(void* data)
472 {
473     Thread* thread = static_cast<Thread*>(data);
474     ASSERT(thread);
475
476     if (thread->m_isDestroyedOnce) {
477         thread->didExit();
478         thread->deref();
479         return;
480     }
481
482     thread->m_isDestroyedOnce = true;
483     // Re-setting the value for key causes another destructTLS() call after all other thread-specific destructors were called.
484 #if !HAVE(FAST_TLS)
485     ASSERT(s_key != InvalidThreadSpecificKey);
486     threadSpecificSet(s_key, thread);
487 #else
488     _pthread_setspecific_direct(WTF_THREAD_DATA_KEY, thread);
489     pthread_key_init_np(WTF_THREAD_DATA_KEY, &destructTLS);
490 #endif
491 }
492
493 Mutex::Mutex()
494 {
495     pthread_mutexattr_t attr;
496     pthread_mutexattr_init(&attr);
497     pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_NORMAL);
498
499     int result = pthread_mutex_init(&m_mutex, &attr);
500     ASSERT_UNUSED(result, !result);
501
502     pthread_mutexattr_destroy(&attr);
503 }
504
505 Mutex::~Mutex()
506 {
507     int result = pthread_mutex_destroy(&m_mutex);
508     ASSERT_UNUSED(result, !result);
509 }
510
511 void Mutex::lock()
512 {
513     int result = pthread_mutex_lock(&m_mutex);
514     ASSERT_UNUSED(result, !result);
515 }
516
517 bool Mutex::tryLock()
518 {
519     int result = pthread_mutex_trylock(&m_mutex);
520
521     if (result == 0)
522         return true;
523     if (result == EBUSY)
524         return false;
525
526     ASSERT_NOT_REACHED();
527     return false;
528 }
529
530 void Mutex::unlock()
531 {
532     int result = pthread_mutex_unlock(&m_mutex);
533     ASSERT_UNUSED(result, !result);
534 }
535
536 ThreadCondition::ThreadCondition()
537
538     pthread_cond_init(&m_condition, NULL);
539 }
540
541 ThreadCondition::~ThreadCondition()
542 {
543     pthread_cond_destroy(&m_condition);
544 }
545     
546 void ThreadCondition::wait(Mutex& mutex)
547 {
548     int result = pthread_cond_wait(&m_condition, &mutex.impl());
549     ASSERT_UNUSED(result, !result);
550 }
551
552 bool ThreadCondition::timedWait(Mutex& mutex, WallTime absoluteTime)
553 {
554     if (absoluteTime < WallTime::now())
555         return false;
556
557     if (absoluteTime > WallTime::fromRawSeconds(INT_MAX)) {
558         wait(mutex);
559         return true;
560     }
561
562     double rawSeconds = absoluteTime.secondsSinceEpoch().value();
563
564     int timeSeconds = static_cast<int>(rawSeconds);
565     int timeNanoseconds = static_cast<int>((rawSeconds - timeSeconds) * 1E9);
566
567     timespec targetTime;
568     targetTime.tv_sec = timeSeconds;
569     targetTime.tv_nsec = timeNanoseconds;
570
571     return pthread_cond_timedwait(&m_condition, &mutex.impl(), &targetTime) == 0;
572 }
573
574 void ThreadCondition::signal()
575 {
576     int result = pthread_cond_signal(&m_condition);
577     ASSERT_UNUSED(result, !result);
578 }
579
580 void ThreadCondition::broadcast()
581 {
582     int result = pthread_cond_broadcast(&m_condition);
583     ASSERT_UNUSED(result, !result);
584 }
585
586 void Thread::yield()
587 {
588     sched_yield();
589 }
590
591 } // namespace WTF
592
593 #endif // USE(PTHREADS)