Rename Source/WebKit2 to Source/WebKit.
[WebKit-https.git] / Source / WebKit / PluginProcess / PluginProcess.cpp
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 #include "config.h"
27 #include "PluginProcess.h"
28
29 #if ENABLE(NETSCAPE_PLUGIN_API)
30
31 #include "ArgumentCoders.h"
32 #include "Attachment.h"
33 #include "NetscapePlugin.h"
34 #include "NetscapePluginModule.h"
35 #include "PluginProcessConnectionMessages.h"
36 #include "PluginProcessCreationParameters.h"
37 #include "PluginProcessProxyMessages.h"
38 #include "WebProcessConnection.h"
39 #include <WebCore/NotImplemented.h>
40 #include <wtf/MemoryPressureHandler.h>
41 #include <wtf/RunLoop.h>
42
43 #if PLATFORM(MAC)
44 #include <crt_externs.h>
45 #endif
46
47 using namespace WebCore;
48
49 namespace WebKit {
50
51 PluginProcess& PluginProcess::singleton()
52 {
53     static NeverDestroyed<PluginProcess> pluginProcess;
54     return pluginProcess;
55 }
56
57 PluginProcess::PluginProcess()
58     : m_supportsAsynchronousPluginInitialization(false)
59     , m_minimumLifetimeTimer(RunLoop::main(), this, &PluginProcess::minimumLifetimeTimerFired)
60     , m_connectionActivity("PluginProcess connection activity.")
61 {
62     NetscapePlugin::setSetExceptionFunction(WebProcessConnection::setGlobalException);
63 }
64
65 PluginProcess::~PluginProcess()
66 {
67 }
68
69 void PluginProcess::initializeProcess(const ChildProcessInitializationParameters& parameters)
70 {
71     m_pluginPath = parameters.extraInitializationData.get("plugin-path");
72     platformInitializeProcess(parameters);
73 }
74
75 void PluginProcess::removeWebProcessConnection(WebProcessConnection* webProcessConnection)
76 {
77     size_t vectorIndex = m_webProcessConnections.find(webProcessConnection);
78     ASSERT(vectorIndex != notFound);
79
80     m_webProcessConnections.remove(vectorIndex);
81     
82     if (m_webProcessConnections.isEmpty() && m_pluginModule) {
83         // Decrement the load count. This is balanced by a call to incrementLoadCount in createWebProcessConnection.
84         m_pluginModule->decrementLoadCount();
85     }        
86
87     enableTermination();
88 }
89
90 NetscapePluginModule* PluginProcess::netscapePluginModule()
91 {
92     if (!m_pluginModule) {
93         ASSERT(!m_pluginPath.isNull());
94         m_pluginModule = NetscapePluginModule::getOrCreate(m_pluginPath);
95
96 #if PLATFORM(MAC)
97         if (m_pluginModule) {
98             if (m_pluginModule->pluginQuirks().contains(PluginQuirks::PrognameShouldBeWebKitPluginHost))
99                 *const_cast<const char**>(_NSGetProgname()) = "WebKitPluginHost";
100         }
101 #endif
102     }
103
104     return m_pluginModule.get();
105 }
106
107 bool PluginProcess::shouldTerminate()
108 {
109     return m_webProcessConnections.isEmpty();
110 }
111
112 void PluginProcess::didReceiveMessage(IPC::Connection& connection, IPC::Decoder& decoder)
113 {
114     didReceivePluginProcessMessage(connection, decoder);
115 }
116
117 void PluginProcess::didClose(IPC::Connection&)
118 {
119     // The UI process has crashed, just quit.
120     // FIXME: If the plug-in is spinning in the main loop, we'll never get this message.
121     stopRunLoop();
122 }
123
124 void PluginProcess::initializePluginProcess(PluginProcessCreationParameters&& parameters)
125 {
126     ASSERT(!m_pluginModule);
127
128     auto& memoryPressureHandler = MemoryPressureHandler::singleton();
129 #if OS(LINUX)
130     if (parameters.memoryPressureMonitorHandle.fileDescriptor() != -1)
131         memoryPressureHandler.setMemoryPressureMonitorHandle(parameters.memoryPressureMonitorHandle.releaseFileDescriptor());
132 #endif
133     memoryPressureHandler.setLowMemoryHandler([this] (Critical, Synchronous) {
134         if (shouldTerminate())
135             terminate();
136     });
137     memoryPressureHandler.install();
138
139     m_supportsAsynchronousPluginInitialization = parameters.supportsAsynchronousPluginInitialization;
140     setMinimumLifetime(parameters.minimumLifetime);
141     setTerminationTimeout(parameters.terminationTimeout);
142
143     platformInitializePluginProcess(WTFMove(parameters));
144 }
145
146 void PluginProcess::createWebProcessConnection()
147 {
148     bool didHaveAnyWebProcessConnections = !m_webProcessConnections.isEmpty();
149
150 #if USE(UNIX_DOMAIN_SOCKETS)
151     IPC::Connection::SocketPair socketPair = IPC::Connection::createPlatformConnection();
152
153     auto connection = WebProcessConnection::create(socketPair.server);
154     m_webProcessConnections.append(WTFMove(connection));
155
156     IPC::Attachment clientSocket(socketPair.client);
157     parentProcessConnection()->send(Messages::PluginProcessProxy::DidCreateWebProcessConnection(clientSocket, m_supportsAsynchronousPluginInitialization), 0);
158 #elif OS(DARWIN)
159     // Create the listening port.
160     mach_port_t listeningPort;
161     mach_port_allocate(mach_task_self(), MACH_PORT_RIGHT_RECEIVE, &listeningPort);
162
163     // Create a listening connection.
164     auto connection = WebProcessConnection::create(IPC::Connection::Identifier(listeningPort));
165
166     m_webProcessConnections.append(WTFMove(connection));
167
168     IPC::Attachment clientPort(listeningPort, MACH_MSG_TYPE_MAKE_SEND);
169     parentProcessConnection()->send(Messages::PluginProcessProxy::DidCreateWebProcessConnection(clientPort, m_supportsAsynchronousPluginInitialization), 0);
170 #else
171     notImplemented();
172 #endif
173
174     if (NetscapePluginModule* module = netscapePluginModule()) {
175         if (!didHaveAnyWebProcessConnections) {
176             // Increment the load count. This is matched by a call to decrementLoadCount in removeWebProcessConnection.
177             // We do this so that the plug-in module's NP_Shutdown won't be called until right before exiting.
178             module->incrementLoadCount();
179         }
180     }
181
182     disableTermination();
183 }
184
185 void PluginProcess::getSitesWithData(uint64_t callbackID)
186 {
187     Vector<String> sites;
188     if (NetscapePluginModule* module = netscapePluginModule())
189         sites = module->sitesWithData();
190
191     parentProcessConnection()->send(Messages::PluginProcessProxy::DidGetSitesWithData(sites, callbackID), 0);
192 }
193
194 void PluginProcess::deleteWebsiteData(std::chrono::system_clock::time_point modifiedSince, uint64_t callbackID)
195 {
196     if (auto* module = netscapePluginModule()) {
197         auto currentTime = std::chrono::system_clock::now();
198
199         if (currentTime > modifiedSince) {
200             uint64_t maximumAge = std::chrono::duration_cast<std::chrono::seconds>(currentTime - modifiedSince).count();
201
202             module->clearSiteData(String(), NP_CLEAR_ALL, maximumAge);
203         }
204     }
205
206     parentProcessConnection()->send(Messages::PluginProcessProxy::DidDeleteWebsiteData(callbackID), 0);
207 }
208
209 void PluginProcess::deleteWebsiteDataForHostNames(const Vector<String>& hostNames, uint64_t callbackID)
210 {
211     if (auto* module = netscapePluginModule()) {
212         for (auto& hostName : hostNames)
213             module->clearSiteData(hostName, NP_CLEAR_ALL, std::numeric_limits<uint64_t>::max());
214     }
215
216     parentProcessConnection()->send(Messages::PluginProcessProxy::DidDeleteWebsiteDataForHostNames(callbackID), 0);
217 }
218
219 void PluginProcess::setMinimumLifetime(Seconds lifetime)
220 {
221     if (lifetime <= 0_s)
222         return;
223     
224     disableTermination();
225     
226     m_minimumLifetimeTimer.startOneShot(lifetime);
227 }
228
229 void PluginProcess::minimumLifetimeTimerFired()
230 {
231     enableTermination();
232 }
233
234 #if !PLATFORM(COCOA)
235 void PluginProcess::initializeProcessName(const ChildProcessInitializationParameters&)
236 {
237 }
238
239 void PluginProcess::initializeSandbox(const ChildProcessInitializationParameters&, SandboxInitializationParameters&)
240 {
241 }
242 #endif
243
244 } // namespace WebKit
245
246 #endif // ENABLE(NETSCAPE_PLUGIN_API)
247