94c70c66d6d832bc9f534e02081ad60ffe53d2a6
[WebKit-https.git] / Source / WTF / wtf / MainThread.h
1 /*
2  * Copyright (C) 2007, 2008, 2010 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 <functional>
34 #include <stdint.h>
35 #include <wtf/Function.h>
36
37 namespace WTF {
38
39 typedef uint32_t ThreadIdentifier;
40
41 // Must be called from the main thread.
42 WTF_EXPORT_PRIVATE void initializeMainThread();
43
44 WTF_EXPORT_PRIVATE void callOnMainThread(Function<void ()>&&);
45
46 #if PLATFORM(COCOA)
47 WTF_EXPORT_PRIVATE void callOnWebThreadOrDispatchAsyncOnMainThread(void (^block)());
48 #endif
49
50 WTF_EXPORT_PRIVATE void setMainThreadCallbacksPaused(bool paused);
51
52 WTF_EXPORT_PRIVATE bool isMainThread();
53
54 WTF_EXPORT_PRIVATE bool canAccessThreadLocalDataForThread(ThreadIdentifier);
55
56 #if USE(WEB_THREAD)
57 WTF_EXPORT_PRIVATE bool isWebThread();
58 WTF_EXPORT_PRIVATE bool isUIThread();
59 WTF_EXPORT_PRIVATE void initializeWebThread();
60 WTF_EXPORT_PRIVATE void initializeApplicationUIThreadIdentifier();
61 WTF_EXPORT_PRIVATE void initializeWebThreadIdentifier();
62 void initializeWebThreadPlatform();
63 #else
64 inline bool isWebThread() { return isMainThread(); }
65 inline bool isUIThread() { return isMainThread(); }
66 #endif // USE(WEB_THREAD)
67
68 void initializeGCThreads();
69
70 WTF_EXPORT_PRIVATE void registerGCThread();
71 WTF_EXPORT_PRIVATE bool isMainThreadOrGCThread();
72
73 // NOTE: these functions are internal to the callOnMainThread implementation.
74 void initializeMainThreadPlatform();
75 void scheduleDispatchFunctionsOnMainThread();
76 void dispatchFunctionsFromMainThread();
77
78 #if OS(DARWIN) && !PLATFORM(EFL) && !PLATFORM(GTK)
79 #if !USE(WEB_THREAD)
80 // This version of initializeMainThread sets up the main thread as corresponding
81 // to the process's main thread, and not necessarily the thread that calls this
82 // function. It should only be used as a legacy aid for Mac WebKit.
83 WTF_EXPORT_PRIVATE void initializeMainThreadToProcessMainThread();
84 #endif // !USE(WEB_THREAD)
85 void initializeMainThreadToProcessMainThreadPlatform();
86 #endif
87
88 } // namespace WTF
89
90 using WTF::callOnMainThread;
91 #if PLATFORM(COCOA)
92 using WTF::callOnWebThreadOrDispatchAsyncOnMainThread;
93 #endif
94 using WTF::setMainThreadCallbacksPaused;
95 using WTF::isMainThread;
96 using WTF::isMainThreadOrGCThread;
97 using WTF::canAccessThreadLocalDataForThread;
98 using WTF::isUIThread;
99 using WTF::isWebThread;
100 #if USE(WEB_THREAD)
101 using WTF::initializeWebThread;
102 using WTF::initializeApplicationUIThreadIdentifier;
103 using WTF::initializeWebThreadIdentifier;
104 #endif
105
106 #endif // MainThread_h