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