4c21facf6ca1e5e42ae53c28942c762fe6337ae7
[WebKit.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 "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)
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 StaticLock 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<StaticLock> 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& 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_identifier;
80     String m_userAgent;
81     String m_sourceCode;
82     WorkerThreadStartMode m_startMode;
83     ContentSecurityPolicyResponseHeaders m_contentSecurityPolicyResponseHeaders;
84     bool m_shouldBypassMainWorldContentSecurityPolicy;
85     bool m_isOnline;
86     Ref<SecurityOrigin> m_topOrigin;
87     MonotonicTime m_timeOrigin;
88     PAL::SessionID m_sessionID;
89 };
90
91 WorkerThreadStartupData::WorkerThreadStartupData(const URL& scriptURL, 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)
92     : m_scriptURL(scriptURL.isolatedCopy())
93     , m_origin(SecurityOrigin::create(m_scriptURL)->isolatedCopy())
94     , m_identifier(identifier.isolatedCopy())
95     , m_userAgent(userAgent.isolatedCopy())
96     , m_sourceCode(sourceCode.isolatedCopy())
97     , m_startMode(startMode)
98     , m_contentSecurityPolicyResponseHeaders(contentSecurityPolicyResponseHeaders.isolatedCopy())
99     , m_shouldBypassMainWorldContentSecurityPolicy(shouldBypassMainWorldContentSecurityPolicy)
100     , m_isOnline(isOnline)
101     , m_topOrigin(topOrigin.isolatedCopy())
102     , m_timeOrigin(timeOrigin)
103     , m_sessionID(sessionID.isolatedCopy())
104 {
105 }
106
107 WorkerThread::WorkerThread(const URL& scriptURL, 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)
108     : m_workerLoaderProxy(workerLoaderProxy)
109     , m_workerDebuggerProxy(workerDebuggerProxy)
110     , m_workerReportingProxy(workerReportingProxy)
111     , m_runtimeFlags(runtimeFlags)
112     , m_startupData(std::make_unique<WorkerThreadStartupData>(scriptURL, identifier, userAgent, isOnline, sourceCode, startMode, contentSecurityPolicyResponseHeaders, shouldBypassMainWorldContentSecurityPolicy, topOrigin, timeOrigin, sessionID))
113 #if ENABLE(INDEXED_DATABASE)
114     , m_idbConnectionProxy(connectionProxy)
115 #endif
116     , m_socketProvider(socketProvider)
117 {
118 #if !ENABLE(INDEXED_DATABASE)
119     UNUSED_PARAM(connectionProxy);
120 #endif
121
122     std::lock_guard<StaticLock> lock(threadSetMutex);
123
124     workerThreads().add(this);
125 }
126
127 WorkerThread::~WorkerThread()
128 {
129     std::lock_guard<StaticLock> lock(threadSetMutex);
130
131     ASSERT(workerThreads().contains(this));
132     workerThreads().remove(this);
133 }
134
135 void WorkerThread::start(WTF::Function<void(const String&)>&& evaluateCallback)
136 {
137     // Mutex protection is necessary to ensure that m_thread is initialized when the thread starts.
138     LockHolder lock(m_threadCreationAndWorkerGlobalScopeMutex);
139
140     if (m_thread)
141         return;
142
143     m_evaluateCallback = WTFMove(evaluateCallback);
144
145     m_thread = Thread::create(isServiceWorkerThread() ? "WebCore: Service Worker" : "WebCore: Worker", [this] {
146         workerThread();
147     });
148 }
149
150 void WorkerThread::workerThread()
151 {
152     auto protectedThis = makeRef(*this);
153
154     // Propagate the mainThread's fenv to workers.
155 #if PLATFORM(IOS)
156     FloatingPointEnvironment::singleton().propagateMainThreadEnvironment();
157 #endif
158
159 #if USE(GLIB)
160     GRefPtr<GMainContext> mainContext = adoptGRef(g_main_context_new());
161     g_main_context_push_thread_default(mainContext.get());
162 #endif
163
164     WorkerScriptController* scriptController;
165     {
166         // Mutex protection is necessary to ensure that we don't change m_workerGlobalScope
167         // while WorkerThread::stop() is accessing it. Note that WorkerThread::stop() can
168         // be called before we've finished creating the WorkerGlobalScope.
169         LockHolder lock(m_threadCreationAndWorkerGlobalScopeMutex);
170         m_workerGlobalScope = createWorkerGlobalScope(m_startupData->m_scriptURL, WTFMove(m_startupData->m_origin), 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);
171
172         scriptController = m_workerGlobalScope->script();
173
174         if (m_runLoop.terminated()) {
175             // The worker was terminated before the thread had a chance to run. Since the context didn't exist yet,
176             // forbidExecution() couldn't be called from stop().
177             scriptController->scheduleExecutionTermination();
178             scriptController->forbidExecution();
179         }
180     }
181
182     if (m_startupData->m_startMode == WorkerThreadStartMode::WaitForInspector) {
183         startRunningDebuggerTasks();
184
185         // If the worker was somehow terminated while processing debugger commands.
186         if (m_runLoop.terminated())
187             scriptController->forbidExecution();
188     }
189
190     String exceptionMessage;
191     scriptController->evaluate(ScriptSourceCode(m_startupData->m_sourceCode, m_startupData->m_scriptURL), &exceptionMessage);
192     
193     callOnMainThread([evaluateCallback = WTFMove(m_evaluateCallback), message = exceptionMessage.isolatedCopy()] {
194         if (evaluateCallback)
195             evaluateCallback(message);
196     });
197     
198     // Free the startup data to cause its member variable deref's happen on the worker's thread (since
199     // all ref/derefs of these objects are happening on the thread at this point). Note that
200     // WorkerThread::~WorkerThread happens on a different thread where it was created.
201     m_startupData = nullptr;
202
203     runEventLoop();
204
205 #if USE(GLIB)
206     g_main_context_pop_thread_default(mainContext.get());
207 #endif
208
209     RefPtr<Thread> protector = m_thread;
210
211     ASSERT(m_workerGlobalScope->hasOneRef());
212
213     RefPtr<WorkerGlobalScope> workerGlobalScopeToDelete;
214     {
215         // Mutex protection is necessary to ensure that we don't change m_workerGlobalScope
216         // while WorkerThread::stop is accessing it.
217         LockHolder lock(m_threadCreationAndWorkerGlobalScopeMutex);
218
219         // Delay the destruction of the WorkerGlobalScope context until after we've unlocked the
220         // m_threadCreationAndWorkerGlobalScopeMutex. This is needed because destructing the
221         // context will trigger the main thread to race against us to delete the WorkerThread
222         // object, and the WorkerThread object owns the mutex we need to unlock after this.
223         workerGlobalScopeToDelete = WTFMove(m_workerGlobalScope);
224
225         if (m_stoppedCallback)
226             callOnMainThread(WTFMove(m_stoppedCallback));
227     }
228
229     // The below assignment will destroy the context, which will in turn notify messaging proxy.
230     // We cannot let any objects survive past thread exit, because no other thread will run GC or otherwise destroy them.
231     workerGlobalScopeToDelete = nullptr;
232
233     // Clean up WebCore::ThreadGlobalData before WTF::Thread goes away!
234     threadGlobalData().destroy();
235
236     // Send the last WorkerThread Ref to be Deref'ed on the main thread.
237     callOnMainThread([protectedThis = WTFMove(protectedThis)] { });
238
239     // The thread object may be already destroyed from notification now, don't try to access "this".
240     protector->detach();
241 }
242
243 void WorkerThread::startRunningDebuggerTasks()
244 {
245     ASSERT(!m_pausedForDebugger);
246     m_pausedForDebugger = true;
247
248     MessageQueueWaitResult result;
249     do {
250         result = m_runLoop.runInMode(m_workerGlobalScope.get(), WorkerRunLoop::debuggerMode());
251     } while (result != MessageQueueTerminated && m_pausedForDebugger);
252 }
253
254 void WorkerThread::stopRunningDebuggerTasks()
255 {
256     m_pausedForDebugger = false;
257 }
258
259 void WorkerThread::runEventLoop()
260 {
261     // Does not return until terminated.
262     m_runLoop.run(m_workerGlobalScope.get());
263 }
264
265 void WorkerThread::stop(WTF::Function<void()>&& stoppedCallback)
266 {
267     // Mutex protection is necessary to ensure that m_workerGlobalScope isn't changed by
268     // WorkerThread::workerThread() while we're accessing it. Note also that stop() can
269     // be called before m_workerGlobalScope is fully created.
270     auto locker = Locker<Lock>::tryLock(m_threadCreationAndWorkerGlobalScopeMutex);
271     if (!locker) {
272         // The thread is still starting, spin the runloop and try again to avoid deadlocks if the worker thread
273         // needs to interact with the main thread during startup.
274         callOnMainThread([this, stoppedCallback = WTFMove(stoppedCallback)]() mutable {
275             stop(WTFMove(stoppedCallback));
276         });
277         return;
278     }
279
280     ASSERT(!m_stoppedCallback);
281     m_stoppedCallback = WTFMove(stoppedCallback);
282
283     // 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.
284     if (m_workerGlobalScope) {
285         m_workerGlobalScope->script()->scheduleExecutionTermination();
286
287         m_runLoop.postTaskAndTerminate({ ScriptExecutionContext::Task::CleanupTask, [] (ScriptExecutionContext& context ) {
288             WorkerGlobalScope& workerGlobalScope = downcast<WorkerGlobalScope>(context);
289
290 #if ENABLE(INDEXED_DATABASE)
291             workerGlobalScope.stopIndexedDatabase();
292 #endif
293
294             workerGlobalScope.stopActiveDOMObjects();
295
296             workerGlobalScope.inspectorController().workerTerminating();
297
298             // Event listeners would keep DOMWrapperWorld objects alive for too long. Also, they have references to JS objects,
299             // which become dangling once Heap is destroyed.
300             workerGlobalScope.removeAllEventListeners();
301
302             // Stick a shutdown command at the end of the queue, so that we deal
303             // with all the cleanup tasks the databases post first.
304             workerGlobalScope.postTask({ ScriptExecutionContext::Task::CleanupTask, [] (ScriptExecutionContext& context) {
305                 WorkerGlobalScope& workerGlobalScope = downcast<WorkerGlobalScope>(context);
306                 // It's not safe to call clearScript until all the cleanup tasks posted by functions initiated by WorkerThreadShutdownStartTask have completed.
307                 workerGlobalScope.clearScript();
308             } });
309
310         } });
311         return;
312     }
313     m_runLoop.terminate();
314 }
315
316 void WorkerThread::releaseFastMallocFreeMemoryInAllThreads()
317 {
318     std::lock_guard<StaticLock> lock(threadSetMutex);
319
320     for (auto* workerThread : workerThreads()) {
321         workerThread->runLoop().postTask([] (ScriptExecutionContext&) {
322             WTF::releaseFastMallocFreeMemory();
323         });
324     }
325 }
326
327 IDBClient::IDBConnectionProxy* WorkerThread::idbConnectionProxy()
328 {
329 #if ENABLE(INDEXED_DATABASE)
330     return m_idbConnectionProxy.get();
331 #else
332     return nullptr;
333 #endif
334 }
335
336 SocketProvider* WorkerThread::socketProvider()
337 {
338     return m_socketProvider.get();
339 }
340
341 } // namespace WebCore