WTF shouldn't have both Thread and ThreadIdentifier
[WebKit.git] / Source / WTF / wtf / MainThread.h
1 /*
2  * Copyright (C) 2007, 2008, 2010, 2016 Apple Inc. All rights reserved.
3  * Copyright (C) 2007 Justin Haygood (jhaygood@reaktix.com)
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef MainThread_h
31 #define MainThread_h
32
33 #include <stdint.h>
34 #include <wtf/Forward.h>
35 #include <wtf/Function.h>
36 #include <wtf/Optional.h>
37 #include <wtf/ThreadingPrimitives.h>
38
39 namespace WTF {
40
41 class PrintStream;
42 class Thread;
43
44 // Must be called from the main thread.
45 WTF_EXPORT_PRIVATE void initializeMainThread();
46
47 WTF_EXPORT_PRIVATE void callOnMainThread(Function<void()>&&);
48 WTF_EXPORT_PRIVATE void callOnMainThreadAndWait(Function<void()>&&);
49
50 #if PLATFORM(COCOA)
51 WTF_EXPORT_PRIVATE void callOnWebThreadOrDispatchAsyncOnMainThread(void (^block)());
52 #endif
53
54 WTF_EXPORT_PRIVATE void setMainThreadCallbacksPaused(bool paused);
55
56 WTF_EXPORT_PRIVATE bool isMainThread();
57
58 WTF_EXPORT_PRIVATE bool canAccessThreadLocalDataForThread(Thread&);
59
60 #if USE(WEB_THREAD)
61 WTF_EXPORT_PRIVATE bool isWebThread();
62 WTF_EXPORT_PRIVATE bool isUIThread();
63 WTF_EXPORT_PRIVATE void initializeWebThread();
64 WTF_EXPORT_PRIVATE void initializeApplicationUIThread();
65 void initializeWebThreadPlatform();
66 #else
67 inline bool isWebThread() { return isMainThread(); }
68 inline bool isUIThread() { return isMainThread(); }
69 #endif // USE(WEB_THREAD)
70
71 WTF_EXPORT_PRIVATE void initializeGCThreads();
72
73 enum class GCThreadType {
74     Main,
75     Helper
76 };
77
78 void printInternal(PrintStream&, GCThreadType);
79
80 WTF_EXPORT_PRIVATE void registerGCThread(GCThreadType);
81 WTF_EXPORT_PRIVATE std::optional<GCThreadType> mayBeGCThread();
82 WTF_EXPORT_PRIVATE bool isMainThreadOrGCThread();
83
84 // NOTE: these functions are internal to the callOnMainThread implementation.
85 void initializeMainThreadPlatform();
86 void scheduleDispatchFunctionsOnMainThread();
87 void dispatchFunctionsFromMainThread();
88
89 #if OS(DARWIN) && !USE(GLIB)
90 #if !USE(WEB_THREAD)
91 // This version of initializeMainThread sets up the main thread as corresponding
92 // to the process's main thread, and not necessarily the thread that calls this
93 // function. It should only be used as a legacy aid for Mac WebKit.
94 WTF_EXPORT_PRIVATE void initializeMainThreadToProcessMainThread();
95 #endif // !USE(WEB_THREAD)
96 void initializeMainThreadToProcessMainThreadPlatform();
97 #endif
98
99 } // namespace WTF
100
101 using WTF::GCThreadType;
102 using WTF::callOnMainThread;
103 using WTF::callOnMainThreadAndWait;
104 using WTF::canAccessThreadLocalDataForThread;
105 using WTF::isMainThread;
106 using WTF::isMainThreadOrGCThread;
107 using WTF::isUIThread;
108 using WTF::isWebThread;
109 using WTF::mayBeGCThread;
110 using WTF::setMainThreadCallbacksPaused;
111 #if PLATFORM(COCOA)
112 using WTF::callOnWebThreadOrDispatchAsyncOnMainThread;
113 #endif
114 #if USE(WEB_THREAD)
115 using WTF::initializeWebThread;
116 using WTF::initializeApplicationUIThread;
117 #endif
118
119 #endif // MainThread_h