b50f131c88b8770763cb75133f6902a8cc09f0c0
[WebKit-https.git] / WebCore / dom / WorkerThread.cpp
1 /*
2  * Copyright (C) 2008 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 COMPUTER, 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 COMPUTER, 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
29 #if ENABLE(WORKERS)
30
31 #include "WorkerThread.h"
32
33 #include "KURL.h"
34 #include "PlatformString.h"
35 #include "ScriptSourceCode.h"
36 #include "ScriptValue.h"
37 #include "Worker.h"
38 #include "WorkerContext.h"
39 #include "WorkerMessagingProxy.h"
40 #include "WorkerTask.h"
41
42 #include <utility>
43 #include <wtf/Noncopyable.h>
44
45 namespace WebCore {
46 struct WorkerThreadStartupData : Noncopyable {
47 public:
48     static std::auto_ptr<WorkerThreadStartupData> create(const KURL& scriptURL, const String& userAgent, const String& sourceCode)
49     {
50         return std::auto_ptr<WorkerThreadStartupData>(new WorkerThreadStartupData(scriptURL, userAgent, sourceCode));
51     }
52
53     KURL m_scriptURL;
54     String m_userAgent;
55     String m_sourceCode;
56 private:
57     WorkerThreadStartupData(const KURL& scriptURL, const String& userAgent, const String& sourceCode);
58 };
59
60 WorkerThreadStartupData::WorkerThreadStartupData(const KURL& scriptURL, const String& userAgent, const String& sourceCode)
61     : m_scriptURL(scriptURL.copy())
62     , m_userAgent(userAgent.copy())
63     , m_sourceCode(sourceCode.copy())
64 {
65 }
66
67 PassRefPtr<WorkerThread> WorkerThread::create(const KURL& scriptURL, const String& userAgent, const String& sourceCode, WorkerMessagingProxy* messagingProxy)
68 {
69     return adoptRef(new WorkerThread(scriptURL, userAgent, sourceCode, messagingProxy));
70 }
71
72 WorkerThread::WorkerThread(const KURL& scriptURL, const String& userAgent, const String& sourceCode, WorkerMessagingProxy* messagingProxy)
73     : m_threadID(0)
74     , m_messagingProxy(messagingProxy)
75     , m_startupData(WorkerThreadStartupData::create(scriptURL, userAgent, sourceCode))
76 {
77 }
78
79 WorkerThread::~WorkerThread()
80 {
81 }
82
83 bool WorkerThread::start()
84 {
85     // Mutex protection is necessary to ensure that m_threadID is initialized when the thread starts.
86     MutexLocker lock(m_threadCreationMutex);
87
88     if (m_threadID)
89         return true;
90
91     m_threadID = createThread(WorkerThread::workerThreadStart, this, "WebCore::Worker");
92
93     return m_threadID;
94 }
95
96 void* WorkerThread::workerThreadStart(void* thread)
97 {
98     return static_cast<WorkerThread*>(thread)->workerThread();
99 }
100
101 void* WorkerThread::workerThread()
102 {
103     {
104         MutexLocker lock(m_threadCreationMutex);
105         m_workerContext = WorkerContext::create(m_startupData->m_scriptURL, m_startupData->m_userAgent, this);
106         if (m_messageQueue.killed()) {
107             // The worker was terminated before the thread had a chance to run. Since the context didn't exist yet, 
108             // forbidExecution() couldn't be called from stop().
109            m_workerContext->script()->forbidExecution();
110         }
111     }
112
113     WorkerScriptController* script = m_workerContext->script();
114     script->evaluate(ScriptSourceCode(m_startupData->m_sourceCode, m_startupData->m_scriptURL));
115     // Free the startup data to cause its member variable deref's happen on the worker's thread (since
116     // all ref/derefs of these objects are happening on the thread at this point). Note that
117     // WorkerThread::~WorkerThread happens on a different thread where it was created.
118     m_startupData.clear();
119
120     m_messagingProxy->confirmWorkerThreadMessage(m_workerContext->hasPendingActivity()); // This wasn't really a message, but it counts as one for GC.
121
122     while (true) {
123         RefPtr<WorkerTask> task;
124         if (!m_messageQueue.waitForMessage(task))
125             break;
126
127         task->performTask(m_workerContext.get());
128     }
129
130     ThreadIdentifier threadID = m_threadID;
131
132     m_workerContext->clearScript();
133     ASSERT(m_workerContext->hasOneRef());
134     // The below assignment will destroy the context, which will in turn notify messaging proxy.
135     // We cannot let any objects survive past thread exit, because no other thread will run GC or otherwise destroy them.
136     m_workerContext = 0;
137     
138     // The thread object may be already destroyed from notification now, don't try to access "this".
139     detachThread(threadID);
140
141     return 0;
142 }
143
144 void WorkerThread::stop()
145 {
146     // Mutex protection is necessary because stop() can be called before the context is fully created.
147     MutexLocker lock(m_threadCreationMutex);
148
149     // 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.
150     if (m_workerContext)
151         m_workerContext->script()->forbidExecution();
152
153     // FIXME: Rudely killing the thread won't work when we allow nested workers, because they will try to post notifications of their destruction.
154     m_messageQueue.kill();
155 }
156
157 } // namespace WebCore
158
159 #endif // ENABLE(WORKERS)