src/third_party/WebKit/Source/core/workers/WorkerThread.h

   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/dom/ExecutionContextTask.h"
  31 #include "core/frame/csp/ContentSecurityPolicy.h"
  32 #include "core/workers/WorkerGlobalScope.h"
  33 #include "platform/SharedTimer.h"
  34 #include "platform/heap/glue/MessageLoopInterruptor.h"
  35 #include "platform/heap/glue/PendingGCRunner.h"
  36 #include "platform/weborigin/SecurityOrigin.h"
  37 #include "public/platform/WebThread.h"
  38 #include "wtf/Forward.h"
  39 #include "wtf/MessageQueue.h"
  40 #include "wtf/OwnPtr.h"
  41 #include "wtf/PassRefPtr.h"
  42 #include "wtf/RefCounted.h"
  43
  44 namespace blink {
  45 class WebWaitableEvent;
  46 }
  47
  48 namespace blink {
  49
  50     class KURL;
  51     class WorkerGlobalScope;
  52     class WorkerInspectorController;
  53     class WorkerLoaderProxy;
  54     class WorkerReportingProxy;
  55     class WorkerSharedTimer;
  56     class WorkerThreadShutdownFinishTask;
  57     class WorkerThreadStartupData;
  58     class WorkerThreadTask;
  59
  60     enum WorkerThreadStartMode { DontPauseWorkerGlobalScopeOnStart, PauseWorkerGlobalScopeOnStart };
  61
  62
  63     class WorkerThread : public RefCounted<WorkerThread> {
  64     public:
  65         virtual ~WorkerThread();
  66
  67         virtual void start();
  68         virtual void stop();
  69
  70         // Can be used to wait for this worker thread to shut down.
  71         // (This is signalled on the main thread, so it's assumed to be waited on the worker context thread)
  72         blink::WebWaitableEvent* shutdownEvent() { return m_shutdownEvent.get(); }
  73
  74         blink::WebWaitableEvent* terminationEvent() { return m_terminationEvent.get(); }
  75         static void terminateAndWaitForAllWorkers();
  76
  77         bool isCurrentThread() const;
  78         WorkerLoaderProxy& workerLoaderProxy() const { return m_workerLoaderProxy; }
  79         WorkerReportingProxy& workerReportingProxy() const { return m_workerReportingProxy; }
  80
  81         void postTask(PassOwnPtr<ExecutionContextTask>);
  82         void postDebuggerTask(PassOwnPtr<ExecutionContextTask>);
  83
  84         enum WaitMode { WaitForMessage, DontWaitForMessage };
  85         MessageQueueWaitResult runDebuggerTask(WaitMode = WaitForMessage);
  86
  87         // These methods should be called if the holder of the thread is
  88         // going to call runDebuggerTask in a loop.
  89         void willEnterNestedLoop();
  90         void didLeaveNestedLoop();
  91
  92         WorkerGlobalScope* workerGlobalScope() const { return m_workerGlobalScope.get(); }
  93         bool terminated() const { return m_terminated; }
  94
  95         // Number of active worker threads.
  96         static unsigned workerThreadCount();
  97
  98         void interruptAndDispatchInspectorCommands();
  99         void setWorkerInspectorController(WorkerInspectorController*);
 100
 101     protected:
 102         WorkerThread(WorkerLoaderProxy&, WorkerReportingProxy&, PassOwnPtrWillBeRawPtr<WorkerThreadStartupData>);
 103
 104         // Factory method for creating a new worker context for the thread.
 105         virtual PassRefPtrWillBeRawPtr<WorkerGlobalScope> createWorkerGlobalScope(PassOwnPtrWillBeRawPtr<WorkerThreadStartupData>) = 0;
 106
 107         virtual void postInitialize() { }
 108
 109     private:
 110         friend class WorkerSharedTimer;
 111         friend class WorkerThreadShutdownFinishTask;
 112
 113         void stopInShutdownSequence();
 114         void stopInternal();
 115
 116         void initialize();
 117         void cleanup();
 118         void idleHandler();
 119         void postDelayedTask(PassOwnPtr<ExecutionContextTask>, long long delayMs);
 120
 121         bool m_terminated;
 122         OwnPtr<WorkerSharedTimer> m_sharedTimer;
 123         MessageQueue<WorkerThreadTask> m_debuggerMessageQueue;
 124         OwnPtr<PendingGCRunner> m_pendingGCRunner;
 125         OwnPtr<WebThread::TaskObserver> m_microtaskRunner;
 126         OwnPtr<MessageLoopInterruptor> m_messageLoopInterruptor;
 127
 128         WorkerLoaderProxy& m_workerLoaderProxy;
 129         WorkerReportingProxy& m_workerReportingProxy;
 130
 131         RefPtrWillBePersistent<WorkerInspectorController> m_workerInspectorController;
 132         Mutex m_workerInspectorControllerMutex;
 133
 134         Mutex m_threadCreationMutex;
 135         RefPtrWillBePersistent<WorkerGlobalScope> m_workerGlobalScope;
 136         OwnPtrWillBePersistent<WorkerThreadStartupData> m_startupData;
 137
 138         // Used to signal thread shutdown.
 139         OwnPtr<blink::WebWaitableEvent> m_shutdownEvent;
 140
 141         // Used to signal thread termination.
 142         OwnPtr<blink::WebWaitableEvent> m_terminationEvent;
 143
 144         // FIXME: This has to be last because of crbug.com/401397 - the
 145         // WorkerThread might get deleted before it had a chance to properly
 146         // shut down. By deleting the WebThread first, we can guarantee that
 147         // no pending tasks on the thread might want to access any of the other
 148         // members during the WorkerThread's destruction.
 149         OwnPtr<blink::WebThread> m_thread;
 150     };
 151
 152 } // namespace blink
 153
 154 #endif // WorkerThread_h