50deb9a9d150b06413211d6aef62d37c0bc93f69
[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 Computer, 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
36 namespace WTF {
37
38 typedef uint32_t ThreadIdentifier;
39 typedef void MainThreadFunction(void*);
40
41 // Must be called from the main thread.
42 WTF_EXPORT_PRIVATE void initializeMainThread();
43
44 WTF_EXPORT_PRIVATE void callOnMainThread(MainThreadFunction*, void* context);
45 WTF_EXPORT_PRIVATE void callOnMainThreadAndWait(MainThreadFunction*, void* context);
46 WTF_EXPORT_PRIVATE void cancelCallOnMainThread(MainThreadFunction*, void* context);
47
48 WTF_EXPORT_PRIVATE void callOnMainThread(std::function<void ()>);
49
50 // FIXME: This symbol is used by Safari and should be removed once Safari is no longer using it.
51 template<typename> class Function;
52 WTF_EXPORT_PRIVATE void callOnMainThread(const Function<void ()>&);
53
54 WTF_EXPORT_PRIVATE void setMainThreadCallbacksPaused(bool paused);
55
56 WTF_EXPORT_PRIVATE bool isMainThread();
57
58 #if USE(WEB_THREAD)
59 WTF_EXPORT_PRIVATE bool isWebThread();
60 WTF_EXPORT_PRIVATE bool isUIThread();
61 WTF_EXPORT_PRIVATE void initializeWebThread();
62 WTF_EXPORT_PRIVATE void initializeApplicationUIThreadIdentifier();
63 WTF_EXPORT_PRIVATE void initializeWebThreadIdentifier();
64 WTF_EXPORT_PRIVATE bool canAccessThreadLocalDataForThread(ThreadIdentifier);
65 void initializeWebThreadPlatform();
66 #else
67 inline bool isWebThread() { return isMainThread(); }
68 inline bool isUIThread() { return isMainThread(); }
69 #endif // USE(WEB_THREAD)
70
71 void initializeGCThreads();
72
73 #if ENABLE(PARALLEL_GC)
74 void registerGCThread();
75 WTF_EXPORT_PRIVATE bool isMainThreadOrGCThread();
76 #elif PLATFORM(MAC) || PLATFORM(IOS)
77 WTF_EXPORT_PRIVATE bool isMainThreadOrGCThread();
78 #else
79 inline bool isMainThreadOrGCThread() { return isMainThread(); }
80 #endif
81
82 // NOTE: these functions are internal to the callOnMainThread implementation.
83 void initializeMainThreadPlatform();
84 void scheduleDispatchFunctionsOnMainThread();
85 void dispatchFunctionsFromMainThread();
86
87 #if PLATFORM(MAC)
88 #if !USE(WEB_THREAD)
89 // This version of initializeMainThread sets up the main thread as corresponding
90 // to the process's main thread, and not necessarily the thread that calls this
91 // function. It should only be used as a legacy aid for Mac WebKit.
92 WTF_EXPORT_PRIVATE void initializeMainThreadToProcessMainThread();
93 #endif // !USE(WEB_THREAD)
94 void initializeMainThreadToProcessMainThreadPlatform();
95 #endif
96
97 } // namespace WTF
98
99 using WTF::callOnMainThread;
100 using WTF::callOnMainThreadAndWait;
101 using WTF::cancelCallOnMainThread;
102 using WTF::setMainThreadCallbacksPaused;
103 using WTF::isMainThread;
104 using WTF::isMainThreadOrGCThread;
105 #if USE(WEB_THREAD)
106 using WTF::initializeWebThread;
107 using WTF::initializeApplicationUIThreadIdentifier;
108 using WTF::initializeWebThreadIdentifier;
109 using WTF::canAccessThreadLocalDataForThread;
110 #endif
111
112 #endif // MainThread_h