Changeset 86578 in webkit

Timestamp:

May 16, 2011 9:34:09 AM (13 years ago)

Author:

andersca@apple.com

Message:

2011-05-16 Anders Carlsson <​andersca@apple.com>

Reviewed by Oliver Hunt.

Short-circuit NPRuntime calls made by Flash during plug-in instantiation
​https://bugs.webkit.org/show_bug.cgi?id=60894
<rdar://problem/8804681>

During plug-in instantiation, Flash makes a couple of NPRuntime calls to get the
URL of the current document as well as the URL of the toplevel document. This leads to
a bunch of IPC traffic that slows down instantiation.

Since we know what calls Flash is making and what results are expected, we can handle the
NPRuntime calls directly in the plug-in process and avoid extra IPC overhead.

• PluginProcess/PluginControllerProxy.cpp: (WebKit::PluginControllerProxy::PluginControllerProxy): Initialize m_pluginCreationParameters.

(WebKit::PluginControllerProxy::initialize):
Set m_pluginCreationParameters to point to the creation parameters right before
calling Plugin::initialize and restore it back afterwards.

(WebKit::PluginControllerProxy::tryToShortCircuitInvoke):
If the plug-in calling NPN_Invoke has the CanShortCircuitSomeNPRuntimeCallsDuringInitialization
quirk, and we're being initialized, check for the flash_getWindowLocation and
flash_getTopLocation function calls and return the correct values.

(WebKit::PluginControllerProxy::tryToShortCircuitEvaluate):
Check if the script string has the definitions of flash_getWindowLocation or flash_getTopLocation
and just ignore them. Note that ignoring them has the effect of not adding them to the window object,
which could in theory be a backwards compatibility problem if web pages were to assume that these
functions existed on a page with plug-ins. In practice this is probably not a problem, especially since
these functions are only used on Mac WebKit.

• PluginProcess/PluginControllerProxy.h: (WebKit::PluginControllerProxy::inInitialize): Add helper function.

• Shared/Plugins/Netscape/mac/NetscapePluginModuleMac.mm: (WebKit::NetscapePluginModule::determineQuirks): Add the CanShortCircuitSomeNPRuntimeCallsDuringInitialization quirk for Flash on Mac.

• Shared/Plugins/PluginQuirks.h: Add Mac specific CanShortCircuitSomeNPRuntimeCallsDuringInitialization quirk.

Location:

trunk/Source/WebKit2

Files:

• ChangeLog (modified) (1 diff)
• PluginProcess/PluginControllerProxy.cpp (modified) (5 diffs)
• PluginProcess/PluginControllerProxy.h (modified) (2 diffs)
• Shared/Plugins/Netscape/mac/NetscapePluginModuleMac.mm (modified) (1 diff)
• Shared/Plugins/PluginQuirks.h (modified) (1 diff)

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2011-05-16  Anders Carlsson  <andersca@apple.com>
+
+        Reviewed by Oliver Hunt.
+
+        Short-circuit NPRuntime calls made by Flash during plug-in instantiation
+        https://bugs.webkit.org/show_bug.cgi?id=60894
+        <rdar://problem/8804681>
+
+        During plug-in instantiation, Flash makes a couple of NPRuntime calls to get the
+        URL of the current document as well as the URL of the toplevel document. This leads to
+        a bunch of IPC traffic that slows down instantiation.
+
+        Since we know what calls Flash is making and what results are expected, we can handle the
+        NPRuntime calls directly in the plug-in process and avoid extra IPC overhead.
+
+        * PluginProcess/PluginControllerProxy.cpp:
+        (WebKit::PluginControllerProxy::PluginControllerProxy):
+        Initialize m_pluginCreationParameters.
+
+        (WebKit::PluginControllerProxy::initialize):
+        Set m_pluginCreationParameters to point to the creation parameters right before
+        calling Plugin::initialize and restore it back afterwards.
+
+        (WebKit::PluginControllerProxy::tryToShortCircuitInvoke):
+        If the plug-in calling NPN_Invoke has the CanShortCircuitSomeNPRuntimeCallsDuringInitialization
+        quirk, and we're being initialized, check for the __flash_getWindowLocation and
+        __flash_getTopLocation function calls and return the correct values.
+
+        (WebKit::PluginControllerProxy::tryToShortCircuitEvaluate):
+        Check if the script string has the definitions of __flash_getWindowLocation or __flash_getTopLocation
+        and just ignore them. Note that ignoring them has the effect of not adding them to the window object,
+        which could in theory be a backwards compatibility problem if web pages were to assume that these
+        functions existed on a page with plug-ins. In practice this is probably not a problem, especially since
+        these functions are only used on Mac WebKit.
+
+        * PluginProcess/PluginControllerProxy.h:
+        (WebKit::PluginControllerProxy::inInitialize):
+        Add helper function.
+
+        * Shared/Plugins/Netscape/mac/NetscapePluginModuleMac.mm:
+        (WebKit::NetscapePluginModule::determineQuirks):
+        Add the CanShortCircuitSomeNPRuntimeCallsDuringInitialization quirk for Flash on Mac.
+
+        * Shared/Plugins/PluginQuirks.h:
+        Add Mac specific CanShortCircuitSomeNPRuntimeCallsDuringInitialization quirk.
+
 2011-05-16  Anders Carlsson  <andersca@apple.com>
 

trunk/Source/WebKit2/PluginProcess/PluginControllerProxy.cpp

@@ -42 +42 @@
 #include "WebProcessConnection.h"
 #include <WebCore/GraphicsContext.h>
+#include <WebCore/IdentifierRep.h>
 #include <WebCore/NotImplemented.h>
 #include <wtf/text/WTFString.h>
@@ -65 +66 @@
     , m_pluginDestructionProtectCount(0)
     , m_pluginDestroyTimer(RunLoop::main(), this, &PluginControllerProxy::destroy)
+    , m_pluginCreationParameters(0)
     , m_waitingForDidUpdate(false)
     , m_pluginCanceledManualStreamLoad(false)
@@ -100 +102 @@
     ASSERT(m_windowNPObject);
 
-    if (!m_plugin->initialize(this, creationParameters.parameters)) {
+    m_pluginCreationParameters = &creationParameters;
+    bool returnValue = m_plugin->initialize(this, creationParameters.parameters);
+    m_pluginCreationParameters = 0;
+
+    if (!returnValue) {
         // Get the plug-in so we can pass it to removePluginControllerProxy. The pointer is only
         // used as an identifier so it's OK to just get a weak reference.
@@ -282 +288 @@
 }
 
-bool PluginControllerProxy::tryToShortCircuitInvoke(NPObject*, NPIdentifier methodName, const NPVariant* arguments, uint32_t argumentCount, bool& returnValue, NPVariant& result)
-{
+bool PluginControllerProxy::tryToShortCircuitInvoke(NPObject* npObject, NPIdentifier methodName, const NPVariant* arguments, uint32_t argumentCount, bool& returnValue, NPVariant& result)
+{
+    // Only try to short circuit evaluate for plug-ins that have the quirk specified.
+    if (!PluginProcess::shared().netscapePluginModule()->pluginQuirks().contains(PluginQuirks::CanShortCircuitSomeNPRuntimeCallsDuringInitialization))
+        return false;
+    
+    // And only when we're in initialize.
+    if (!inInitialize())
+        return false;
+    
+    // And only when the NPObject is the window NPObject.
+    if (npObject != m_windowNPObject)
+        return false;
+
+    // And only when we don't have any arguments.
+    if (argumentCount)
+        return false;
+
+    IdentifierRep* methodNameRep = static_cast<IdentifierRep*>(methodName);
+    if (!methodNameRep->isString())
+        return false;
+
+    if (!strcmp(methodNameRep->string(), "__flash_getWindowLocation")) {
+        result.type = NPVariantType_String;
+        result.value.stringValue = createNPString(m_pluginCreationParameters->parameters.documentURL.utf8()); 
+        returnValue = true;
+        return true;
+    }
+    
+    if (!strcmp(methodNameRep->string(), "__flash_getTopLocation")) {
+        if (m_pluginCreationParameters->parameters.toplevelDocumentURL.isNull()) {
+            // If the toplevel document is URL it means that the frame that the plug-in is in doesn't have access to the toplevel document.
+            returnValue = false;
+            return true;
+        }
+
+        result.type = NPVariantType_String;
+        result.value.stringValue = createNPString(m_pluginCreationParameters->parameters.toplevelDocumentURL.utf8()); 
+        returnValue = true;
+        return true;
+    }
+
     return false;
 }
@@ -543 +589 @@
 bool PluginControllerProxy::tryToShortCircuitEvaluate(NPObject* npObject, const String& scriptString, NPVariant* result)
 {
-    return false;
+    // Only try to short circuit evaluate for plug-ins that have the quirk specified.
+    if (!PluginProcess::shared().netscapePluginModule()->pluginQuirks().contains(PluginQuirks::CanShortCircuitSomeNPRuntimeCallsDuringInitialization))
+        return false;
+
+    // And only when we're in initialize.
+    if (!inInitialize())
+        return false;
+
+    // And only when the NPObject is the window NPObject.
+    if (npObject != m_windowNPObject)
+        return false;
+
+    // Now, check for the right strings.
+    if (scriptString != "function __flash_getWindowLocation() { return window.location; }"
+        && scriptString != "function __flash_getTopLocation() { return top.location; }")
+        return false;
+
+    VOID_TO_NPVARIANT(*result);
+    return true;
 }
 

trunk/Source/WebKit2/PluginProcess/PluginControllerProxy.h

@@ -144 +144 @@
     bool tryToShortCircuitEvaluate(NPObject*, const String& scriptString, NPVariant* result);
 
+    bool inInitialize() const { return m_pluginCreationParameters; }
+
     void platformInitialize();
     void platformDestroy();
@@ -174 +176 @@
     RunLoop::Timer<PluginControllerProxy> m_pluginDestroyTimer;
 
+    // Will point to the plug-in creation parameters of the plug-in we're currently initializing and will be null when we're done initializing.
+    const PluginCreationParameters* m_pluginCreationParameters;
+
     // Whether we're waiting for the plug-in proxy in the web process to draw the contents of its
     // backing store into the web process backing store.

trunk/Source/WebKit2/Shared/Plugins/Netscape/mac/NetscapePluginModuleMac.mm

@@ -416 +416 @@
         // Flash supports snapshotting.
         m_pluginQuirks.add(PluginQuirks::SupportsSnapshotting);
+
+        // We can short circuit some NPRuntime calls during initialization.
+        m_pluginQuirks.add(PluginQuirks::CanShortCircuitSomeNPRuntimeCallsDuringInitialization);
     }
 

trunk/Source/WebKit2/Shared/Plugins/PluginQuirks.h

@@ -48 +48 @@
         // transparent.
         MakeTransparentIfBackgroundAttributeExists,
+
+        // Whether we can short circuit some NPRuntime calls during plug-in initialization.
+        // The Flash plug-in uses NPRuntime to figure out the URL of the frame it is in, as well
+        // as the URL of the main frame. Since we know the exact NPRuntime calls the plug-in makes,
+        // we can return the right values without having to do sync IPC back into the web process.
+        CanShortCircuitSomeNPRuntimeCallsDuringInitialization,
 
 #ifndef NP_NO_QUICKDRAW