Home | History | Annotate | Download | only in workers 
      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/page/ContentSecurityPolicy.h"
     31 #include "core/workers/WorkerRunLoop.h"
     32 #include "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 WebCore {
     39 
     40     class KURL;
     41     class NotificationClient;
     42     class WorkerGlobalScope;
     43     class WorkerLoaderProxy;
     44     class WorkerReportingProxy;
     45     struct WorkerThreadStartupData;
     46 
     47     enum WorkerThreadStartMode { DontPauseWorkerGlobalScopeOnStart, PauseWorkerGlobalScopeOnStart };
     48 
     49     class WorkerThread : public RefCounted<WorkerThread> {
     50     public:
     51         virtual ~WorkerThread();
     52 
     53         bool start();
     54         void stop();
     55 
     56         bool isCurrentThread() const;
     57         WorkerRunLoop& runLoop() { return m_runLoop; }
     58         WorkerLoaderProxy& workerLoaderProxy() const { return m_workerLoaderProxy; }
     59         WorkerReportingProxy& workerReportingProxy() const { return m_workerReportingProxy; }
     60 
     61         // Number of active worker threads.
     62         static unsigned workerThreadCount();
     63         static void releaseFastMallocFreeMemoryInAllThreads();
     64 
     65 #if ENABLE(NOTIFICATIONS) || ENABLE(LEGACY_NOTIFICATIONS)
     66         NotificationClient* getNotificationClient() { return m_notificationClient; }
     67         void setNotificationClient(NotificationClient* client) { m_notificationClient = client; }
     68 #endif
     69 
     70     protected:
     71         WorkerThread(WorkerLoaderProxy&, WorkerReportingProxy&, PassOwnPtr<WorkerThreadStartupData>);
     72 
     73         // Factory method for creating a new worker context for the thread.
     74         virtual PassRefPtr<WorkerGlobalScope> createWorkerGlobalScope(PassOwnPtr<WorkerThreadStartupData>) = 0;
     75 
     76         // Executes the event loop for the worker thread. Derived classes can override to perform actions before/after entering the event loop.
     77         virtual void runEventLoop();
     78 
     79         WorkerGlobalScope* workerGlobalScope() { return m_workerGlobalScope.get(); }
     80 
     81     private:
     82         // Static function executed as the core routine on the new thread. Passed a pointer to a WorkerThread object.
     83         static void workerThreadStart(void*);
     84 
     85         void workerThread();
     86 
     87         ThreadIdentifier m_threadID;
     88         WorkerRunLoop m_runLoop;
     89         WorkerLoaderProxy& m_workerLoaderProxy;
     90         WorkerReportingProxy& m_workerReportingProxy;
     91 
     92         RefPtr<WorkerGlobalScope> m_workerGlobalScope;
     93         Mutex m_threadCreationMutex;
     94 
     95         OwnPtr<WorkerThreadStartupData> m_startupData;
     96 
     97 #if ENABLE(NOTIFICATIONS) || ENABLE(LEGACY_NOTIFICATIONS)
     98         NotificationClient* m_notificationClient;
     99 #endif
    100     };
    101 
    102 } // namespace WebCore
    103 
    104 #endif // WorkerThread_h
    105