a5cb843c97caea6a08beb5f4f02b29290baa24ae
[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 WTF_EXPORT_PRIVATE void setMainThreadCallbacksPaused(bool paused);
51
52 WTF_EXPORT_PRIVATE bool isMainThread();
53
54 #if USE(WEB_THREAD)
55 WTF_EXPORT_PRIVATE bool isWebThread();
56 WTF_EXPORT_PRIVATE bool isUIThread();
57 WTF_EXPORT_PRIVATE void initializeWebThread();
58 WTF_EXPORT_PRIVATE void initializeApplicationUIThreadIdentifier();
59 WTF_EXPORT_PRIVATE void initializeWebThreadIdentifier();
60 WTF_EXPORT_PRIVATE bool canAccessThreadLocalDataForThread(ThreadIdentifier);
61 void initializeWebThreadPlatform();
62 #else
63 inline bool isWebThread() { return isMainThread(); }
64 inline bool isUIThread() { return isMainThread(); }
65 #endif // USE(WEB_THREAD)
66
67 void initializeGCThreads();
68
69 #if ENABLE(PARALLEL_GC)
70 void registerGCThread();
71 WTF_EXPORT_PRIVATE bool isMainThreadOrGCThread();
72 #elif PLATFORM(MAC) || PLATFORM(IOS)
73 WTF_EXPORT_PRIVATE bool isMainThreadOrGCThread();
74 #else
75 inline bool isMainThreadOrGCThread() { return isMainThread(); }
76 #endif
77
78 // NOTE: these functions are internal to the callOnMainThread implementation.
79 void initializeMainThreadPlatform();
80 void scheduleDispatchFunctionsOnMainThread();
81 void dispatchFunctionsFromMainThread();
82
83 #if PLATFORM(MAC)
84 #if !USE(WEB_THREAD)
85 // This version of initializeMainThread sets up the main thread as corresponding
86 // to the process's main thread, and not necessarily the thread that calls this
87 // function. It should only be used as a legacy aid for Mac WebKit.
88 WTF_EXPORT_PRIVATE void initializeMainThreadToProcessMainThread();
89 #endif // !USE(WEB_THREAD)
90 void initializeMainThreadToProcessMainThreadPlatform();
91 #endif
92
93 } // namespace WTF
94
95 using WTF::callOnMainThread;
96 using WTF::callOnMainThreadAndWait;
97 using WTF::cancelCallOnMainThread;
98 using WTF::setMainThreadCallbacksPaused;
99 using WTF::isMainThread;
100 using WTF::isMainThreadOrGCThread;
101 #if USE(WEB_THREAD)
102 using WTF::initializeWebThread;
103 using WTF::initializeApplicationUIThreadIdentifier;
104 using WTF::initializeWebThreadIdentifier;
105 using WTF::canAccessThreadLocalDataForThread;
106 #endif
107
108 #endif // MainThread_h