Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / workers / WorkerThread.cpp
1 /*
2  * Copyright (C) 2008-2017 Apple Inc. All Rights Reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  */
26
27 #include "config.h"
28 #include "WorkerThread.h"
29
30 #include "ContentSecurityPolicyResponseHeaders.h"
31 #include "IDBConnectionProxy.h"
32 #include "ScriptSourceCode.h"
33 #include "SecurityOrigin.h"
34 #include "SocketProvider.h"
35 #include "ThreadGlobalData.h"
36 #include <wtf/URL.h>
37 #include "WorkerGlobalScope.h"
38 #include "WorkerInspectorController.h"
39 #include <utility>
40 #include <wtf/Lock.h>
41 #include <wtf/NeverDestroyed.h>
42 #include <wtf/Noncopyable.h>
43 #include <wtf/text/WTFString.h>
44
45 #if PLATFORM(IOS_FAMILY)
46 #include "FloatingPointEnvironment.h"
47 #include "WebCoreThread.h"
48 #endif
49
50 #if USE(GLIB)
51 #include <wtf/glib/GRefPtr.h>
52 #endif
53
54 namespace WebCore {
55
56 static Lock threadSetMutex;
57
58 static HashSet<WorkerThread*>& workerThreads()
59 {
60     static NeverDestroyed<HashSet<WorkerThread*>> workerThreads;
61
62     return workerThreads;
63 }
64
65 unsigned WorkerThread::workerThreadCount()
66 {
67     std::lock_guard<Lock> lock(threadSetMutex);
68
69     return workerThreads().size();
70 }
71
72 struct WorkerThreadStartupData {
73     WTF_MAKE_NONCOPYABLE(WorkerThreadStartupData); WTF_MAKE_FAST_ALLOCATED;
74 public:
75     WorkerThreadStartupData(const URL& scriptURL, const String& name, const String& identifier, const String& userAgent, bool isOnline, const String& sourceCode, WorkerThreadStartMode, const ContentSecurityPolicyResponseHeaders&, bool shouldBypassMainWorldContentSecurityPolicy, const SecurityOrigin& topOrigin, MonotonicTime timeOrigin, PAL::SessionID);
76
77     URL m_scriptURL;
78     Ref<SecurityOrigin> m_origin;
79     String m_name;
80     String m_identifier;
81     String m_userAgent;
82     String m_sourceCode;
83     WorkerThreadStartMode m_startMode;
84     ContentSecurityPolicyResponseHeaders m_contentSecurityPolicyResponseHeaders;
85     bool m_shouldBypassMainWorldContentSecurityPolicy;
86     bool m_isOnline;
87     Ref<SecurityOrigin> m_topOrigin;
88     MonotonicTime m_timeOrigin;
89     PAL::SessionID m_sessionID;
90 };
91
92 WorkerThreadStartupData::WorkerThreadStartupData(const URL& scriptURL, const String& name, const String& identifier, const String& userAgent, bool isOnline, const String& sourceCode, WorkerThreadStartMode startMode, const ContentSecurityPolicyResponseHeaders& contentSecurityPolicyResponseHeaders, bool shouldBypassMainWorldContentSecurityPolicy, const SecurityOrigin& topOrigin, MonotonicTime timeOrigin, PAL::SessionID sessionID)
93     : m_scriptURL(scriptURL.isolatedCopy())
94     , m_origin(SecurityOrigin::create(m_scriptURL)->isolatedCopy())
95     , m_name(name.isolatedCopy())
96     , m_identifier(identifier.isolatedCopy())
97     , m_userAgent(userAgent.isolatedCopy())
98     , m_sourceCode(sourceCode.isolatedCopy())
99     , m_startMode(startMode)
100     , m_contentSecurityPolicyResponseHeaders(contentSecurityPolicyResponseHeaders.isolatedCopy())
101     , m_shouldBypassMainWorldContentSecurityPolicy(shouldBypassMainWorldContentSecurityPolicy)
102     , m_isOnline(isOnline)
103     , m_topOrigin(topOrigin.isolatedCopy())
104     , m_timeOrigin(timeOrigin)
105     , m_sessionID(sessionID.isolatedCopy())
106 {
107 }
108
109 WorkerThread::WorkerThread(const URL& scriptURL, const String& name, const String& identifier, const String& userAgent, bool isOnline, const String& sourceCode, WorkerLoaderProxy& workerLoaderProxy, WorkerDebuggerProxy& workerDebuggerProxy, WorkerReportingProxy& workerReportingProxy, WorkerThreadStartMode startMode, const ContentSecurityPolicyResponseHeaders& contentSecurityPolicyResponseHeaders, bool shouldBypassMainWorldContentSecurityPolicy, const SecurityOrigin& topOrigin, MonotonicTime timeOrigin, IDBClient::IDBConnectionProxy* connectionProxy, SocketProvider* socketProvider, JSC::RuntimeFlags runtimeFlags, PAL::SessionID sessionID)
110     : m_workerLoaderProxy(workerLoaderProxy)
111     , m_workerDebuggerProxy(workerDebuggerProxy)
112     , m_workerReportingProxy(workerReportingProxy)
113     , m_runtimeFlags(runtimeFlags)
114     , m_startupData(std::make_unique<WorkerThreadStartupData>(scriptURL, name, identifier, userAgent, isOnline, sourceCode, startMode, contentSecurityPolicyResponseHeaders, shouldBypassMainWorldContentSecurityPolicy, topOrigin, timeOrigin, sessionID))
115 #if ENABLE(INDEXED_DATABASE)
116     , m_idbConnectionProxy(connectionProxy)
117 #endif
118     , m_socketProvider(socketProvider)
119 {
120 #if !ENABLE(INDEXED_DATABASE)
121     UNUSED_PARAM(connectionProxy);
122 #endif
123
124     std::lock_guard<Lock> lock(threadSetMutex);
125
126     workerThreads().add(this);
127 }
128
129 WorkerThread::~WorkerThread()
130 {
131     std::lock_guard<Lock> lock(threadSetMutex);
132
133     ASSERT(workerThreads().contains(this));
134     workerThreads().remove(this);
135 }
136
137 void WorkerThread::start(WTF::Function<void(const String&)>&& evaluateCallback)
138 {
139     // Mutex protection is necessary to ensure that m_thread is initialized when the thread starts.
140     LockHolder lock(m_threadCreationAndWorkerGlobalScopeMutex);
141
142     if (m_thread)
143         return;
144
145     m_evaluateCallback = WTFMove(evaluateCallback);
146
147     m_thread = Thread::create(isServiceWorkerThread() ? "WebCore: Service Worker" : "WebCore: Worker", [this] {
148         workerThread();
149     });
150 }
151
152 void WorkerThread::workerThread()
153 {
154     auto protectedThis = makeRef(*this);
155
156     // Propagate the mainThread's fenv to workers.
157 #if PLATFORM(IOS_FAMILY)
158     FloatingPointEnvironment::singleton().propagateMainThreadEnvironment();
159 #endif
160
161 #if USE(GLIB)
162     GRefPtr<GMainContext> mainContext = adoptGRef(g_main_context_new());
163     g_main_context_push_thread_default(mainContext.get());
164 #endif
165
166     WorkerScriptController* scriptController;
167     {
168         // Mutex protection is necessary to ensure that we don't change m_workerGlobalScope
169         // while WorkerThread::stop() is accessing it. Note that WorkerThread::stop() can
170         // be called before we've finished creating the WorkerGlobalScope.
171         LockHolder lock(m_threadCreationAndWorkerGlobalScopeMutex);
172         m_workerGlobalScope = createWorkerGlobalScope(m_startupData->m_scriptURL, WTFMove(m_startupData->m_origin), m_startupData->m_name, m_startupData->m_identifier, m_startupData->m_userAgent, m_startupData->m_isOnline, m_startupData->m_contentSecurityPolicyResponseHeaders, m_startupData->m_shouldBypassMainWorldContentSecurityPolicy, WTFMove(m_startupData->m_topOrigin), m_startupData->m_timeOrigin, m_startupData->m_sessionID);
173
174         scriptController = m_workerGlobalScope->script();
175
176         if (m_runLoop.terminated()) {
177             // The worker was terminated before the thread had a chance to run. Since the context didn't exist yet,
178             // forbidExecution() couldn't be called from stop().
179             scriptController->scheduleExecutionTermination();
180             scriptController->forbidExecution();
181         }
182     }
183
184     if (m_startupData->m_startMode == WorkerThreadStartMode::WaitForInspector) {
185         startRunningDebuggerTasks();
186
187         // If the worker was somehow terminated while processing debugger commands.
188         if (m_runLoop.terminated())
189             scriptController->forbidExecution();
190     }
191
192     String exceptionMessage;
193     scriptController->evaluate(ScriptSourceCode(m_startupData->m_sourceCode, m_startupData->m_scriptURL), &exceptionMessage);
194     
195     callOnMainThread([evaluateCallback = WTFMove(m_evaluateCallback), message = exceptionMessage.isolatedCopy()] {
196         if (evaluateCallback)
197             evaluateCallback(message);
198     });
199     
200     // Free the startup data to cause its member variable deref's happen on the worker's thread (since
201     // all ref/derefs of these objects are happening on the thread at this point). Note that
202     // WorkerThread::~WorkerThread happens on a different thread where it was created.
203     m_startupData = nullptr;
204
205     runEventLoop();
206
207 #if USE(GLIB)
208     g_main_context_pop_thread_default(mainContext.get());
209 #endif
210
211     RefPtr<Thread> protector = m_thread;
212
213     ASSERT(m_workerGlobalScope->hasOneRef());
214
215     RefPtr<WorkerGlobalScope> workerGlobalScopeToDelete;
216     {
217         // Mutex protection is necessary to ensure that we don't change m_workerGlobalScope
218         // while WorkerThread::stop is accessing it.
219         LockHolder lock(m_threadCreationAndWorkerGlobalScopeMutex);
220
221         // Delay the destruction of the WorkerGlobalScope context until after we've unlocked the
222         // m_threadCreationAndWorkerGlobalScopeMutex. This is needed because destructing the
223         // context will trigger the main thread to race against us to delete the WorkerThread
224         // object, and the WorkerThread object owns the mutex we need to unlock after this.
225         workerGlobalScopeToDelete = WTFMove(m_workerGlobalScope);
226
227         if (m_stoppedCallback)
228             callOnMainThread(WTFMove(m_stoppedCallback));
229     }
230
231     // The below assignment will destroy the context, which will in turn notify messaging proxy.
232     // We cannot let any objects survive past thread exit, because no other thread will run GC or otherwise destroy them.
233     workerGlobalScopeToDelete = nullptr;
234
235     // Clean up WebCore::ThreadGlobalData before WTF::Thread goes away!
236     threadGlobalData().destroy();
237
238     // Send the last WorkerThread Ref to be Deref'ed on the main thread.
239     callOnMainThread([protectedThis = WTFMove(protectedThis)] { });
240
241     // The thread object may be already destroyed from notification now, don't try to access "this".
242     protector->detach();
243 }
244
245 void WorkerThread::startRunningDebuggerTasks()
246 {
247     ASSERT(!m_pausedForDebugger);
248     m_pausedForDebugger = true;
249
250     MessageQueueWaitResult result;
251     do {
252         result = m_runLoop.runInMode(m_workerGlobalScope.get(), WorkerRunLoop::debuggerMode());
253     } while (result != MessageQueueTerminated && m_pausedForDebugger);
254 }
255
256 void WorkerThread::stopRunningDebuggerTasks()
257 {
258     m_pausedForDebugger = false;
259 }
260
261 void WorkerThread::runEventLoop()
262 {
263     // Does not return until terminated.
264     m_runLoop.run(m_workerGlobalScope.get());
265 }
266
267 void WorkerThread::stop(WTF::Function<void()>&& stoppedCallback)
268 {
269     // Mutex protection is necessary to ensure that m_workerGlobalScope isn't changed by
270     // WorkerThread::workerThread() while we're accessing it. Note also that stop() can
271     // be called before m_workerGlobalScope is fully created.
272     auto locker = Locker<Lock>::tryLock(m_threadCreationAndWorkerGlobalScopeMutex);
273     if (!locker) {
274         // The thread is still starting, spin the runloop and try again to avoid deadlocks if the worker thread
275         // needs to interact with the main thread during startup.
276         callOnMainThread([this, stoppedCallback = WTFMove(stoppedCallback)]() mutable {
277             stop(WTFMove(stoppedCallback));
278         });
279         return;
280     }
281
282     ASSERT(!m_stoppedCallback);
283     m_stoppedCallback = WTFMove(stoppedCallback);
284
285     // Ensure that tasks are being handled by thread event loop. If script execution weren't forbidden, a while(1) loop in JS could keep the thread alive forever.
286     if (m_workerGlobalScope) {
287         m_workerGlobalScope->script()->scheduleExecutionTermination();
288
289         m_runLoop.postTaskAndTerminate({ ScriptExecutionContext::Task::CleanupTask, [] (ScriptExecutionContext& context ) {
290             WorkerGlobalScope& workerGlobalScope = downcast<WorkerGlobalScope>(context);
291
292             workerGlobalScope.prepareForTermination();
293
294             // Stick a shutdown command at the end of the queue, so that we deal
295             // with all the cleanup tasks the databases post first.
296             workerGlobalScope.postTask({ ScriptExecutionContext::Task::CleanupTask, [] (ScriptExecutionContext& context) {
297                 WorkerGlobalScope& workerGlobalScope = downcast<WorkerGlobalScope>(context);
298                 // It's not safe to call clearScript until all the cleanup tasks posted by functions initiated by WorkerThreadShutdownStartTask have completed.
299                 workerGlobalScope.clearScript();
300             } });
301
302         } });
303         return;
304     }
305     m_runLoop.terminate();
306 }
307
308 void WorkerThread::releaseFastMallocFreeMemoryInAllThreads()
309 {
310     std::lock_guard<Lock> lock(threadSetMutex);
311
312     for (auto* workerThread : workerThreads()) {
313         workerThread->runLoop().postTask([] (ScriptExecutionContext&) {
314             WTF::releaseFastMallocFreeMemory();
315         });
316     }
317 }
318
319 IDBClient::IDBConnectionProxy* WorkerThread::idbConnectionProxy()
320 {
321 #if ENABLE(INDEXED_DATABASE)
322     return m_idbConnectionProxy.get();
323 #else
324     return nullptr;
325 #endif
326 }
327
328 SocketProvider* WorkerThread::socketProvider()
329 {
330     return m_socketProvider.get();
331 }
332
333 } // namespace WebCore