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#pragma once
31
32#include <stdint.h>
33#include <wtf/Forward.h>
34#include <wtf/Function.h>
35#include <wtf/ThreadingPrimitives.h>
36
37namespace WTF {
38
39class PrintStream;
40class Thread;
41
42// Must be called from the main thread.
43WTF_EXPORT_PRIVATE void initializeMainThread();
44
45WTF_EXPORT_PRIVATE void callOnMainThread(Function<void()>&&);
46WTF_EXPORT_PRIVATE void callOnMainThreadAndWait(Function<void()>&&);
47
48#if PLATFORM(COCOA)
49WTF_EXPORT_PRIVATE void dispatchAsyncOnMainThreadWithWebThreadLockIfNeeded(void (^block)());
50WTF_EXPORT_PRIVATE void callOnWebThreadOrDispatchAsyncOnMainThread(void (^block)());
51#endif
52
53WTF_EXPORT_PRIVATE void setMainThreadCallbacksPaused(bool paused);
54
55WTF_EXPORT_PRIVATE bool isMainThread();
56WTF_EXPORT_PRIVATE bool isMainThreadIfInitialized();
57
58WTF_EXPORT_PRIVATE bool canAccessThreadLocalDataForThread(Thread&);
59
60#if USE(WEB_THREAD)
61WTF_EXPORT_PRIVATE bool isWebThread();
62WTF_EXPORT_PRIVATE bool isUIThread();
63WTF_EXPORT_PRIVATE void initializeWebThread();
64WTF_EXPORT_PRIVATE void initializeApplicationUIThread();
65void initializeWebThreadPlatform();
66#else
67inline bool isWebThread() { return isMainThread(); }
68inline bool isUIThread() { return isMainThread(); }
69#endif // USE(WEB_THREAD)
70
71WTF_EXPORT_PRIVATE bool isMainThreadOrGCThread();
72
73// NOTE: these functions are internal to the callOnMainThread implementation.
74void initializeMainThreadPlatform();
75void scheduleDispatchFunctionsOnMainThread();
76void dispatchFunctionsFromMainThread();
77
78#if OS(DARWIN) && !USE(GLIB)
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.
83WTF_EXPORT_PRIVATE void initializeMainThreadToProcessMainThread();
84#endif // !USE(WEB_THREAD)
85void initializeMainThreadToProcessMainThreadPlatform();
86#endif
87
88} // namespace WTF
89
90using WTF::callOnMainThread;
91using WTF::callOnMainThreadAndWait;
92using WTF::canAccessThreadLocalDataForThread;
93using WTF::isMainThread;
94using WTF::isMainThreadOrGCThread;
95using WTF::isUIThread;
96using WTF::isWebThread;
97using WTF::setMainThreadCallbacksPaused;
98#if PLATFORM(COCOA)
99using WTF::dispatchAsyncOnMainThreadWithWebThreadLockIfNeeded;
100using WTF::callOnWebThreadOrDispatchAsyncOnMainThread;
101#endif
102#if USE(WEB_THREAD)
103using WTF::initializeWebThread;
104using WTF::initializeApplicationUIThread;
105#endif
106