• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 #ifndef WorkerThread_h
28 #define WorkerThread_h
29 
30 #include "core/frame/csp/ContentSecurityPolicy.h"
31 #include "core/workers/WorkerRunLoop.h"
32 #include "platform/weborigin/SecurityOrigin.h"
33 #include "wtf/Forward.h"
34 #include "wtf/OwnPtr.h"
35 #include "wtf/PassRefPtr.h"
36 #include "wtf/RefCounted.h"
37 
38 namespace blink {
39 class WebWaitableEvent;
40 }
41 
42 namespace WebCore {
43 
44     class KURL;
45     class NotificationClient;
46     class WorkerGlobalScope;
47     class WorkerLoaderProxy;
48     class WorkerReportingProxy;
49     class WorkerThreadStartupData;
50 
51     enum WorkerThreadStartMode { DontPauseWorkerGlobalScopeOnStart, PauseWorkerGlobalScopeOnStart };
52 
53     class WorkerThread : public RefCounted<WorkerThread> {
54     public:
55         virtual ~WorkerThread();
56 
57         bool start();
58         void stop();
59 
60         // Can be used to wait for this worker thread to shut down.
61         // (This is signalled on the main thread, so it's assumed to be waited on the worker context thread)
shutdownEvent()62         blink::WebWaitableEvent* shutdownEvent() { return m_shutdownEvent.get(); }
63 
64         bool isCurrentThread() const;
runLoop()65         WorkerRunLoop& runLoop() { return m_runLoop; }
workerLoaderProxy()66         WorkerLoaderProxy& workerLoaderProxy() const { return m_workerLoaderProxy; }
workerReportingProxy()67         WorkerReportingProxy& workerReportingProxy() const { return m_workerReportingProxy; }
68 
69         // Number of active worker threads.
70         static unsigned workerThreadCount();
71 
getNotificationClient()72         NotificationClient* getNotificationClient() { return m_notificationClient; }
setNotificationClient(NotificationClient * client)73         void setNotificationClient(NotificationClient* client) { m_notificationClient = client; }
74 
75     protected:
76         WorkerThread(WorkerLoaderProxy&, WorkerReportingProxy&, PassOwnPtrWillBeRawPtr<WorkerThreadStartupData>);
77 
78         // Factory method for creating a new worker context for the thread.
79         virtual PassRefPtrWillBeRawPtr<WorkerGlobalScope> createWorkerGlobalScope(PassOwnPtrWillBeRawPtr<WorkerThreadStartupData>) = 0;
80 
81         // Executes the event loop for the worker thread. Derived classes can override to perform actions before/after entering the event loop.
82         virtual void runEventLoop();
83 
workerGlobalScope()84         WorkerGlobalScope* workerGlobalScope() { return m_workerGlobalScope.get(); }
85 
86     private:
87         // Static function executed as the core routine on the new thread. Passed a pointer to a WorkerThread object.
88         static void workerThreadStart(void*);
89 
90         void workerThread();
91 
92         ThreadIdentifier m_threadID;
93         WorkerRunLoop m_runLoop;
94         WorkerLoaderProxy& m_workerLoaderProxy;
95         WorkerReportingProxy& m_workerReportingProxy;
96 
97         RefPtrWillBePersistent<WorkerGlobalScope> m_workerGlobalScope;
98         Mutex m_threadCreationMutex;
99 
100         OwnPtrWillBePersistent<WorkerThreadStartupData> m_startupData;
101 
102         NotificationClient* m_notificationClient;
103 
104         // Used to signal thread shutdown.
105         OwnPtr<blink::WebWaitableEvent> m_shutdownEvent;
106     };
107 
108 } // namespace WebCore
109 
110 #endif // WorkerThread_h
111