diff -r 000000000000 -r 6474c204b198 dom/plugins/ipc/PluginModuleChild.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/dom/plugins/ipc/PluginModuleChild.h	Wed Dec 31 06:09:35 2014 +0100
@@ -0,0 +1,455 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ * vim: sw=4 ts=4 et :
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef dom_plugins_PluginModuleChild_h
+#define dom_plugins_PluginModuleChild_h 1
+
+#include "mozilla/Attributes.h"
+
+#include <string>
+#include <vector>
+
+#include "base/basictypes.h"
+
+#include "prlink.h"
+
+#include "npapi.h"
+#include "npfunctions.h"
+
+#include "nsAutoPtr.h"
+#include "nsDataHashtable.h"
+#include "nsTHashtable.h"
+#include "nsHashKeys.h"
+
+#ifdef MOZ_WIDGET_COCOA
+#include "PluginInterposeOSX.h"
+#endif
+
+#include "mozilla/plugins/PPluginModuleChild.h"
+#include "mozilla/plugins/PluginInstanceChild.h"
+#include "mozilla/plugins/PluginIdentifierChild.h"
+#include "mozilla/plugins/PluginMessageUtils.h"
+
+// NOTE: stolen from nsNPAPIPlugin.h
+
+#if defined(XP_WIN)
+#define NS_NPAPIPLUGIN_CALLBACK(_type, _name) _type (__stdcall * _name)
+#else
+#define NS_NPAPIPLUGIN_CALLBACK(_type, _name) _type (* _name)
+#endif
+
+typedef NS_NPAPIPLUGIN_CALLBACK(NPError, NP_GETENTRYPOINTS) (NPPluginFuncs* pCallbacks);
+typedef NS_NPAPIPLUGIN_CALLBACK(NPError, NP_PLUGININIT) (const NPNetscapeFuncs* pCallbacks);
+typedef NS_NPAPIPLUGIN_CALLBACK(NPError, NP_PLUGINUNIXINIT) (const NPNetscapeFuncs* pCallbacks, NPPluginFuncs* fCallbacks);
+typedef NS_NPAPIPLUGIN_CALLBACK(NPError, NP_PLUGINSHUTDOWN) (void);
+
+namespace mozilla {
+namespace dom {
+class PCrashReporterChild;
+}
+
+namespace plugins {
+
+#ifdef MOZ_WIDGET_QT
+class NestedLoopTimer;
+static const int kNestedLoopDetectorIntervalMs = 90;
+#endif
+
+class PluginScriptableObjectChild;
+class PluginInstanceChild;
+
+class PluginModuleChild : public PPluginModuleChild
+{
+    typedef mozilla::dom::PCrashReporterChild PCrashReporterChild;
+protected:
+    virtual mozilla::ipc::RacyInterruptPolicy
+    MediateInterruptRace(const Message& parent, const Message& child) MOZ_OVERRIDE
+    {
+        return MediateRace(parent, child);
+    }
+
+    virtual bool ShouldContinueFromReplyTimeout() MOZ_OVERRIDE;
+
+    // Implement the PPluginModuleChild interface
+    virtual bool AnswerNP_GetEntryPoints(NPError* rv) MOZ_OVERRIDE;
+    virtual bool AnswerNP_Initialize(const uint32_t& aFlags, NPError* rv) MOZ_OVERRIDE;
+
+    virtual PPluginIdentifierChild*
+    AllocPPluginIdentifierChild(const nsCString& aString,
+                                const int32_t& aInt,
+                                const bool& aTemporary) MOZ_OVERRIDE;
+
+    virtual bool
+    RecvPPluginIdentifierConstructor(PPluginIdentifierChild* actor,
+                                     const nsCString& aString,
+                                     const int32_t& aInt,
+                                     const bool& aTemporary) MOZ_OVERRIDE;
+
+    virtual bool
+    DeallocPPluginIdentifierChild(PPluginIdentifierChild* aActor) MOZ_OVERRIDE;
+
+    virtual PPluginInstanceChild*
+    AllocPPluginInstanceChild(const nsCString& aMimeType,
+                              const uint16_t& aMode,
+                              const InfallibleTArray<nsCString>& aNames,
+                              const InfallibleTArray<nsCString>& aValues,
+                              NPError* rv) MOZ_OVERRIDE;
+
+    virtual bool
+    DeallocPPluginInstanceChild(PPluginInstanceChild* aActor) MOZ_OVERRIDE;
+
+    virtual bool
+    AnswerPPluginInstanceConstructor(PPluginInstanceChild* aActor,
+                                     const nsCString& aMimeType,
+                                     const uint16_t& aMode,
+                                     const InfallibleTArray<nsCString>& aNames,
+                                     const InfallibleTArray<nsCString>& aValues,
+                                     NPError* rv) MOZ_OVERRIDE;
+    virtual bool
+    AnswerNP_Shutdown(NPError *rv) MOZ_OVERRIDE;
+
+    virtual bool
+    AnswerOptionalFunctionsSupported(bool *aURLRedirectNotify,
+                                     bool *aClearSiteData,
+                                     bool *aGetSitesWithData) MOZ_OVERRIDE;
+
+    virtual bool
+    AnswerNPP_ClearSiteData(const nsCString& aSite,
+                            const uint64_t& aFlags,
+                            const uint64_t& aMaxAge,
+                            NPError* aResult) MOZ_OVERRIDE;
+
+    virtual bool
+    AnswerNPP_GetSitesWithData(InfallibleTArray<nsCString>* aResult) MOZ_OVERRIDE;
+
+    virtual bool
+    RecvSetAudioSessionData(const nsID& aId,
+                            const nsString& aDisplayName,
+                            const nsString& aIconPath) MOZ_OVERRIDE;
+
+    virtual bool
+    RecvSetParentHangTimeout(const uint32_t& aSeconds) MOZ_OVERRIDE;
+
+    virtual PCrashReporterChild*
+    AllocPCrashReporterChild(mozilla::dom::NativeThreadId* id,
+                             uint32_t* processType) MOZ_OVERRIDE;
+    virtual bool
+    DeallocPCrashReporterChild(PCrashReporterChild* actor) MOZ_OVERRIDE;
+    virtual bool
+    AnswerPCrashReporterConstructor(PCrashReporterChild* actor,
+                                    mozilla::dom::NativeThreadId* id,
+                                    uint32_t* processType) MOZ_OVERRIDE;
+
+    virtual void
+    ActorDestroy(ActorDestroyReason why) MOZ_OVERRIDE;
+
+    MOZ_NORETURN void QuickExit();
+
+    virtual bool
+    RecvProcessNativeEventsInInterruptCall() MOZ_OVERRIDE;
+
+    virtual bool
+    AnswerGeckoGetProfile(nsCString* aProfile) MOZ_OVERRIDE;
+
+public:
+    PluginModuleChild();
+    virtual ~PluginModuleChild();
+
+    // aPluginFilename is UTF8, not native-charset!
+    bool Init(const std::string& aPluginFilename,
+              base::ProcessHandle aParentProcessHandle,
+              MessageLoop* aIOLoop,
+              IPC::Channel* aChannel);
+
+    void CleanUp();
+
+    const char* GetUserAgent();
+
+    static const NPNetscapeFuncs sBrowserFuncs;
+
+    static PluginModuleChild* current();
+
+    bool RegisterActorForNPObject(NPObject* aObject,
+                                  PluginScriptableObjectChild* aActor);
+
+    void UnregisterActorForNPObject(NPObject* aObject);
+
+    PluginScriptableObjectChild* GetActorForNPObject(NPObject* aObject);
+
+#ifdef DEBUG
+    bool NPObjectIsRegistered(NPObject* aObject);
+#endif
+
+    bool AsyncDrawingAllowed() { return mAsyncDrawingAllowed; }
+
+    /**
+     * The child implementation of NPN_CreateObject.
+     */
+    static NPObject* NPN_CreateObject(NPP aNPP, NPClass* aClass);
+    /**
+     * The child implementation of NPN_RetainObject.
+     */
+    static NPObject* NPN_RetainObject(NPObject* aNPObj);
+    /**
+     * The child implementation of NPN_ReleaseObject.
+     */
+    static void NPN_ReleaseObject(NPObject* aNPObj);
+
+    /**
+     * The child implementations of NPIdentifier-related functions.
+     */
+    static NPIdentifier NPN_GetStringIdentifier(const NPUTF8* aName);
+    static void NPN_GetStringIdentifiers(const NPUTF8** aNames,
+                                                     int32_t aNameCount,
+                                                     NPIdentifier* aIdentifiers);
+    static NPIdentifier NPN_GetIntIdentifier(int32_t aIntId);
+    static bool NPN_IdentifierIsString(NPIdentifier aIdentifier);
+    static NPUTF8* NPN_UTF8FromIdentifier(NPIdentifier aIdentifier);
+    static int32_t NPN_IntFromIdentifier(NPIdentifier aIdentifier);
+
+#ifdef MOZ_WIDGET_COCOA
+    void ProcessNativeEvents();
+    
+    void PluginShowWindow(uint32_t window_id, bool modal, CGRect r) {
+        SendPluginShowWindow(window_id, modal, r.origin.x, r.origin.y, r.size.width, r.size.height);
+    }
+
+    void PluginHideWindow(uint32_t window_id) {
+        SendPluginHideWindow(window_id);
+    }
+
+    void SetCursor(NSCursorInfo& cursorInfo) {
+        SendSetCursor(cursorInfo);
+    }
+
+    void ShowCursor(bool show) {
+        SendShowCursor(show);
+    }
+
+    void PushCursor(NSCursorInfo& cursorInfo) {
+        SendPushCursor(cursorInfo);
+    }
+
+    void PopCursor() {
+        SendPopCursor();
+    }
+
+    bool GetNativeCursorsSupported() {
+        bool supported = false;
+        SendGetNativeCursorsSupported(&supported);
+        return supported;
+    }
+#endif
+
+    // Quirks mode support for various plugin mime types
+    enum PluginQuirks {
+        QUIRKS_NOT_INITIALIZED                          = 0,
+        // Silverlight assumes it is transparent in windowless mode. This quirk
+        // matches the logic in nsNPAPIPluginInstance::SetWindowless.
+        QUIRK_SILVERLIGHT_DEFAULT_TRANSPARENT           = 1 << 0,
+        // Win32: Hook TrackPopupMenu api so that we can swap out parent
+        // hwnds. The api will fail with parents not associated with our
+        // child ui thread. See WinlessHandleEvent for details.
+        QUIRK_WINLESS_TRACKPOPUP_HOOK                   = 1 << 1,
+        // Win32: Throttle flash WM_USER+1 heart beat messages to prevent
+        // flooding chromium's dispatch loop, which can cause ipc traffic
+        // processing lag.
+        QUIRK_FLASH_THROTTLE_WMUSER_EVENTS              = 1 << 2,
+        // Win32: Catch resets on our subclass by hooking SetWindowLong.
+        QUIRK_FLASH_HOOK_SETLONGPTR                     = 1 << 3,
+        // X11: Work around a bug in Flash up to 10.1 d51 at least, where
+        // expose event top left coordinates within the plugin-rect and
+        // not at the drawable origin are misinterpreted.
+        QUIRK_FLASH_EXPOSE_COORD_TRANSLATION            = 1 << 4,
+        // Win32: Catch get window info calls on the browser and tweak the
+        // results so mouse input works when flash is displaying it's settings
+        // window.
+        QUIRK_FLASH_HOOK_GETWINDOWINFO                  = 1 << 5,
+        // Win: Addresses a flash bug with mouse capture and full screen
+        // windows.
+        QUIRK_FLASH_FIXUP_MOUSE_CAPTURE                 = 1 << 6,
+        // Win: QuickTime steals focus on SetWindow calls even if it's hidden.
+        // Avoid calling SetWindow in that case.
+        QUIRK_QUICKTIME_AVOID_SETWINDOW                 = 1 << 7,
+        // Win: Check to make sure the parent window has focus before calling
+        // set focus on the child. Addresses a full screen dialog prompt
+        // problem in Silverlight.
+        QUIRK_SILVERLIGHT_FOCUS_CHECK_PARENT            = 1 << 8,
+        // Mac: Allow the plugin to use offline renderer mode.
+        // Use this only if the plugin is certified the support the offline renderer.
+        QUIRK_ALLOW_OFFLINE_RENDERER                    = 1 << 9,
+        // Mac: Work around a Flash bug that can cause plugin process crashes
+        // in CoreGraphics mode:  The Flash plugin sometimes accesses the
+        // CGContextRef we pass to it in NPP_HandleEvent(NPCocoaEventDrawRect)
+        // outside of that call.  See bug 804606.
+        QUIRK_FLASH_AVOID_CGMODE_CRASHES                = 1 << 10,
+    };
+
+    int GetQuirks() { return mQuirks; }
+
+private:
+    void AddQuirk(PluginQuirks quirk) {
+      if (mQuirks == QUIRKS_NOT_INITIALIZED)
+        mQuirks = 0;
+      mQuirks |= quirk;
+    }
+    void InitQuirksModes(const nsCString& aMimeType);
+    bool InitGraphics();
+    void DeinitGraphics();
+#if defined(MOZ_WIDGET_GTK)
+    static gboolean DetectNestedEventLoop(gpointer data);
+    static gboolean ProcessBrowserEvents(gpointer data);
+
+    virtual void EnteredCxxStack() MOZ_OVERRIDE;
+    virtual void ExitedCxxStack() MOZ_OVERRIDE;
+#elif defined(MOZ_WIDGET_QT)
+
+    virtual void EnteredCxxStack() MOZ_OVERRIDE;
+    virtual void ExitedCxxStack() MOZ_OVERRIDE;
+#endif
+
+    PRLibrary* mLibrary;
+    nsCString mPluginFilename; // UTF8
+    nsCString mUserAgent;
+    int mQuirks;
+    bool mAsyncDrawingAllowed;
+
+    // we get this from the plugin
+    NP_PLUGINSHUTDOWN mShutdownFunc;
+#if defined(OS_LINUX) || defined(OS_BSD)
+    NP_PLUGINUNIXINIT mInitializeFunc;
+#elif defined(OS_WIN) || defined(OS_MACOSX)
+    NP_PLUGININIT mInitializeFunc;
+    NP_GETENTRYPOINTS mGetEntryPointsFunc;
+#endif
+
+    NPPluginFuncs mFunctions;
+    NPSavedData mSavedData;
+
+#if defined(MOZ_WIDGET_GTK)
+    // If a plugin spins a nested glib event loop in response to a
+    // synchronous IPC message from the browser, the loop might break
+    // only after the browser responds to a request sent by the
+    // plugin.  This can happen if a plugin uses gtk's synchronous
+    // copy/paste, for example.  But because the browser is blocked on
+    // a condvar, it can't respond to the request.  This situation
+    // isn't technically a deadlock, but the symptoms are basically
+    // the same from the user's perspective.
+    //
+    // We take two steps to prevent this
+    //
+    //  (1) Detect nested event loops spun by the plugin.  This is
+    //      done by scheduling a glib timer event in the plugin
+    //      process whenever the browser might block on the plugin.
+    //      If the plugin indeed spins a nested loop, this timer event
+    //      will fire "soon" thereafter.
+    //
+    //  (2) When a nested loop is detected, deschedule the
+    //      nested-loop-detection timer and in its place, schedule
+    //      another timer that periodically calls back into the
+    //      browser and spins a mini event loop.  This mini event loop
+    //      processes a handful of pending native events.
+    //
+    // Because only timer (1) or (2) (or neither) may be active at any
+    // point in time, we use the same member variable
+    // |mNestedLoopTimerId| to refer to both.
+    //
+    // When the browser no longer might be blocked on a plugin's IPC
+    // response, we deschedule whichever of (1) or (2) is active.
+    guint mNestedLoopTimerId;
+#  ifdef DEBUG
+    // Depth of the stack of calls to g_main_context_dispatch before any
+    // nested loops are run.  This is 1 when IPC calls are dispatched from
+    // g_main_context_iteration, or 0 when dispatched directly from
+    // MessagePumpForUI.
+    int mTopLoopDepth;
+#  endif
+#elif defined (MOZ_WIDGET_QT)
+    NestedLoopTimer *mNestedLoopTimerObject;
+#endif
+
+    struct NPObjectData : public nsPtrHashKey<NPObject>
+    {
+        NPObjectData(const NPObject* key)
+            : nsPtrHashKey<NPObject>(key)
+            , instance(nullptr)
+            , actor(nullptr)
+        { }
+
+        // never nullptr
+        PluginInstanceChild* instance;
+
+        // sometimes nullptr (no actor associated with an NPObject)
+        PluginScriptableObjectChild* actor;
+    };
+    /**
+     * mObjectMap contains all the currently active NPObjects (from NPN_CreateObject until the
+     * final release/dealloc, whether or not an actor is currently associated with the object.
+     */
+    nsTHashtable<NPObjectData> mObjectMap;
+
+    friend class PluginIdentifierChild;
+    friend class PluginIdentifierChildString;
+    friend class PluginIdentifierChildInt;
+    nsDataHashtable<nsCStringHashKey, PluginIdentifierChildString*> mStringIdentifiers;
+    nsDataHashtable<nsUint32HashKey, PluginIdentifierChildInt*> mIntIdentifiers;
+
+public: // called by PluginInstanceChild
+    /**
+     * Dealloc an NPObject after last-release or when the associated instance
+     * is destroyed. This function will remove the object from mObjectMap.
+     */
+    static void DeallocNPObject(NPObject* o);
+
+    NPError NPP_Destroy(PluginInstanceChild* instance) {
+        return mFunctions.destroy(instance->GetNPP(), 0);
+    }
+
+    /**
+     * Fill PluginInstanceChild.mDeletingHash with all the remaining NPObjects
+     * associated with that instance.
+     */
+    void FindNPObjectsForInstance(PluginInstanceChild* instance);
+
+private:
+    static PLDHashOperator CollectForInstance(NPObjectData* d, void* userArg);
+
+#if defined(OS_WIN)
+    virtual void EnteredCall() MOZ_OVERRIDE;
+    virtual void ExitedCall() MOZ_OVERRIDE;
+
+    // Entered/ExitedCall notifications keep track of whether the plugin has
+    // entered a nested event loop within this interrupt call.
+    struct IncallFrame
+    {
+        IncallFrame()
+            : _spinning(false)
+            , _savedNestableTasksAllowed(false)
+        { }
+
+        bool _spinning;
+        bool _savedNestableTasksAllowed;
+    };
+
+    nsAutoTArray<IncallFrame, 8> mIncallPumpingStack;
+
+    static LRESULT CALLBACK NestedInputEventHook(int code,
+                                                 WPARAM wParam,
+                                                 LPARAM lParam);
+    static LRESULT CALLBACK CallWindowProcHook(int code,
+                                               WPARAM wParam,
+                                               LPARAM lParam);
+    void SetEventHooks();
+    void ResetEventHooks();
+    HHOOK mNestedEventHook;
+    HHOOK mGlobalCallWndProcHook;
+#endif
+};
+
+} /* namespace plugins */
+} /* namespace mozilla */
+
+#endif  // ifndef dom_plugins_PluginModuleChild_h