Access MemoryPressureHandler global instance via a singleton() static member function
[WebKit-https.git] / Source / WebKit2 / PluginProcess / PluginProcess.h
1 /*
2  * Copyright (C) 2010 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 INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef PluginProcess_h
27 #define PluginProcess_h
28
29 #if ENABLE(NETSCAPE_PLUGIN_API)
30
31 #include "ChildProcess.h"
32 #include <WebCore/CountedUserActivity.h>
33 #include <WebCore/AudioHardwareListener.h>
34 #include <wtf/Forward.h>
35 #include <wtf/NeverDestroyed.h>
36 #include <wtf/text/WTFString.h>
37
38 #if PLATFORM(COCOA)
39 #include <WebCore/MachSendRight.h>
40 #endif
41
42 namespace WebKit {
43
44 class NetscapePluginModule;
45 class WebProcessConnection;
46 struct PluginProcessCreationParameters;
47         
48 class PluginProcess : public ChildProcess, private WebCore::AudioHardwareListener::Client
49 {
50     WTF_MAKE_NONCOPYABLE(PluginProcess);
51     friend class NeverDestroyed<PluginProcess>;
52 public:
53     static PluginProcess& singleton();
54
55     void removeWebProcessConnection(WebProcessConnection*);
56
57     NetscapePluginModule* netscapePluginModule();
58
59     const String& pluginPath() const { return m_pluginPath; }
60
61 #if PLATFORM(COCOA)
62     void setModalWindowIsShowing(bool);
63     void setFullscreenWindowIsShowing(bool);
64
65     const WebCore::MachSendRight& compositingRenderServerPort() const { return m_compositingRenderServerPort; }
66
67     bool launchProcess(const String& launchPath, const Vector<String>& arguments);
68     bool launchApplicationAtURL(const String& urlString, const Vector<String>& arguments);
69     bool openURL(const String& urlString, int32_t& status, String& launchedURLString);
70     bool openFile(const String& urlString);
71 #endif
72
73     CountedUserActivity& connectionActivity() { return m_connectionActivity; }
74
75 private:
76     PluginProcess();
77     ~PluginProcess();
78
79     // ChildProcess
80     virtual void initializeProcess(const ChildProcessInitializationParameters&) override;
81     virtual void initializeProcessName(const ChildProcessInitializationParameters&) override;
82     virtual void initializeSandbox(const ChildProcessInitializationParameters&, SandboxInitializationParameters&) override;
83     virtual bool shouldTerminate() override;
84     void platformInitializeProcess(const ChildProcessInitializationParameters&);
85
86 #if USE(APPKIT)
87     virtual void stopRunLoop() override;
88 #endif
89
90     // IPC::Connection::Client
91     virtual void didReceiveMessage(IPC::Connection&, IPC::MessageDecoder&) override;
92     virtual void didClose(IPC::Connection&) override;
93     virtual void didReceiveInvalidMessage(IPC::Connection&, IPC::StringReference messageReceiverName, IPC::StringReference messageName) override;
94     virtual IPC::ProcessType localProcessType() override { return IPC::ProcessType::Plugin; }
95     virtual IPC::ProcessType remoteProcessType() override { return IPC::ProcessType::UI; }
96
97     // Message handlers.
98     void didReceivePluginProcessMessage(IPC::Connection&, IPC::MessageDecoder&);
99     void initializePluginProcess(PluginProcessCreationParameters&&);
100     void createWebProcessConnection();
101     void getSitesWithData(uint64_t callbackID);
102     void clearSiteData(const Vector<String>& sites, uint64_t flags, uint64_t maxAgeInSeconds, uint64_t callbackID);
103     
104     // AudioHardwareListenerClient
105     virtual void audioHardwareDidBecomeActive() override;
106     virtual void audioHardwareDidBecomeInactive() override;
107     virtual void audioOutputDeviceChanged() override { }
108
109     void platformInitializePluginProcess(PluginProcessCreationParameters&&);
110     
111     void setMinimumLifetime(double);
112     void minimumLifetimeTimerFired();
113     // Our web process connections.
114     Vector<RefPtr<WebProcessConnection>> m_webProcessConnections;
115
116     // The plug-in path.
117     String m_pluginPath;
118
119 #if PLATFORM(COCOA)
120     String m_pluginBundleIdentifier;
121 #endif
122
123     // The plug-in module.
124     RefPtr<NetscapePluginModule> m_pluginModule;
125     
126     bool m_supportsAsynchronousPluginInitialization;
127
128     RunLoop::Timer<PluginProcess> m_minimumLifetimeTimer;
129
130 #if PLATFORM(COCOA)
131     // The Mach port used for accelerated compositing.
132     WebCore::MachSendRight m_compositingRenderServerPort;
133
134     String m_nsurlCacheDirectory;
135 #endif
136
137     CountedUserActivity m_connectionActivity;
138
139     RefPtr<WebCore::AudioHardwareListener> m_audioHardwareListener;
140 };
141
142 } // namespace WebKit
143
144 #endif // ENABLE(NETSCAPE_PLUGIN_API)
145
146 #endif // PluginProcess_h