Bug 1553270 - Part 1: Store the protocol ID on IProtocol directly, r=froydnj

This allows for the getter to be used in IProtocol's destructor, and generally
brings IProtocol more in line with IToplevelProtocol.

Differential Revision: https://phabricator.services.mozilla.com/D32042

--HG--
extra : moz-landing-system : lando

dom/file/ipc/IPCBlobUtils.cpp

@@ -261,7 +261,7 @@ nsresult SerializeUntyped(BlobImpl* aBlobImpl, IProtocol* aActor,
   }
 
   // We always need the toplevel protocol
-  switch (manager->GetProtocolTypeId()) {
+  switch (manager->GetProtocolId()) {
     case PBackgroundMsgStart:
       if (manager->GetSide() == mozilla::ipc::ParentSide) {
         return SerializeInternal(

dom/ipc/WindowGlobalParent.cpp

@@ -98,7 +98,7 @@ void WindowGlobalParent::Init(const WindowGlobalInit& aInit) {
   if (mInProcess) {
     // In the in-process case, we can get it from the other side's
     // WindowGlobalChild.
-    MOZ_ASSERT(Manager()->GetProtocolTypeId() == PInProcessMsgStart);
+    MOZ_ASSERT(Manager()->GetProtocolId() == PInProcessMsgStart);
     RefPtr<WindowGlobalChild> otherSide = GetChildActor();
     if (otherSide && otherSide->WindowGlobal()) {
       // Get the toplevel window from the other side.
@@ -110,7 +110,7 @@ void WindowGlobalParent::Init(const WindowGlobalInit& aInit) {
     }
   } else {
     // In the cross-process case, we can get the frame element from our manager.
-    MOZ_ASSERT(Manager()->GetProtocolTypeId() == PBrowserMsgStart);
+    MOZ_ASSERT(Manager()->GetProtocolId() == PBrowserMsgStart);
     frameElement = static_cast<BrowserParent*>(Manager())->GetOwnerElement();
   }
 

dom/plugins/ipc/PluginModuleParent.cpp

@@ -885,7 +885,7 @@ PluginInstanceParent* PluginModuleChromeParent::GetManagingInstance(
     mozilla::ipc::IProtocol* aProtocol) {
   MOZ_ASSERT(aProtocol);
   mozilla::ipc::IProtocol* listener = aProtocol;
-  switch (listener->GetProtocolTypeId()) {
+  switch (listener->GetProtocolId()) {
     case PPluginInstanceMsgStart:
       // In this case, aProtocol is the instance itself. Just cast it.
       return static_cast<PluginInstanceParent*>(aProtocol);

ipc/glue/IPCStreamUtils.cpp

@@ -459,7 +459,7 @@ void IPDLParamTraits<nsIInputStream*>::Write(IPC::Message* aMsg,
   // protocols we support.
   IProtocol* actor = aActor;
   while (!found && actor) {
-    switch (actor->GetProtocolTypeId()) {
+    switch (actor->GetProtocolId()) {
       case PContentMsgStart:
         if (actor->GetSide() == mozilla::ipc::ParentSide) {
           ok = autoStream.Serialize(

ipc/glue/InProcessImpl.cpp

@@ -141,7 +141,7 @@ static IProtocol* GetOtherInProcessActor(IProtocol* aActor) {
   // Discover the manager of aActor which is PInProcess.
   IProtocol* current = aActor;
   while (current) {
-    if (current->GetProtocolTypeId() == PInProcessMsgStart) {
+    if (current->GetProtocolId() == PInProcessMsgStart) {
       break;  // Found the correct actor.
     }
     current = current->Manager();
@@ -173,7 +173,7 @@ static IProtocol* GetOtherInProcessActor(IProtocol* aActor) {
   if (otherActor) {
     MOZ_ASSERT(otherActor->GetSide() != UnknownSide, "bad unknown side");
     MOZ_ASSERT(otherActor->GetSide() != aActor->GetSide(), "Wrong side!");
-    MOZ_ASSERT(otherActor->GetProtocolTypeId() == aActor->GetProtocolTypeId(),
+    MOZ_ASSERT(otherActor->GetProtocolId() == aActor->GetProtocolId(),
                "Wrong type of protocol!");
   }
 

ipc/glue/ProtocolUtils.cpp

@@ -406,7 +406,7 @@ Maybe<IProtocol*> IProtocol::ReadActor(const IPC::Message* aMessage,
     return Nothing();
   }
 
-  if (listener->GetProtocolTypeId() != aProtocolTypeId) {
+  if (listener->GetProtocolId() != aProtocolTypeId) {
     MismatchedActorTypeError(aActorDescription);
     return Nothing();
   }
@@ -702,8 +702,7 @@ void IProtocol::DestroySubtree(ActorDestroyReason aWhy) {
 
 IToplevelProtocol::IToplevelProtocol(const char* aName, ProtocolId aProtoId,
                                      Side aSide)
-    : IProtocol(aSide, MakeUnique<ToplevelState>(aName, this, aSide)),
-      mProtocolId(aProtoId),
+    : IProtocol(aProtoId, aSide, MakeUnique<ToplevelState>(aName, this, aSide)),
       mOtherPid(mozilla::ipc::kInvalidProcessId),
       mIsMainThreadProtocol(false) {}
 

ipc/glue/ProtocolUtils.h

@@ -153,6 +153,8 @@ enum class LinkStatus : uint8_t {
   Destroyed,
 };
 
+typedef IPCMessageStart ProtocolId;
+
 class IToplevelProtocol;
 class ActorLifecycleProxy;
 
@@ -268,8 +270,8 @@ class IProtocol : public HasResultCodes {
   typedef IPC::Message Message;
   typedef IPC::MessageInfo MessageInfo;
 
-  explicit IProtocol(Side aSide)
-      : IProtocol(aSide, MakeUnique<ManagedState>(this)) {}
+  explicit IProtocol(ProtocolId aProtoId, Side aSide)
+      : IProtocol(aProtoId, aSide, MakeUnique<ManagedState>(this)) {}
 
   int32_t Register(IProtocol* aRouted) { return mState->Register(aRouted); }
   int32_t RegisterID(IProtocol* aRouted, int32_t aId) {
@@ -330,7 +332,7 @@ class IProtocol : public HasResultCodes {
                                    Message*& aReply) = 0;
   virtual Result OnCallReceived(const Message& aMessage, Message*& aReply) = 0;
 
-  virtual int32_t GetProtocolTypeId() = 0;
+  ProtocolId GetProtocolId() const { return mProtocolId; }
 
   int32_t Id() const { return mId; }
   IProtocol* Manager() const { return mManager; }
@@ -364,8 +366,9 @@ class IProtocol : public HasResultCodes {
   ActorLifecycleProxy* GetLifecycleProxy() { return mLifecycleProxy; }
 
  protected:
-  IProtocol(Side aSide, UniquePtr<ProtocolState> aState)
+  IProtocol(ProtocolId aProtoId, Side aSide, UniquePtr<ProtocolState> aState)
       : mId(0),
+        mProtocolId(aProtoId),
         mSide(aSide),
         mLinkStatus(LinkStatus::Inactive),
         mLifecycleProxy(nullptr),
@@ -433,7 +436,7 @@ class IProtocol : public HasResultCodes {
   // The actor has been freed after this method returns.
   virtual void ActorDealloc() {
     if (Manager()) {
-      Manager()->DeallocManagee(GetProtocolTypeId(), this);
+      Manager()->DeallocManagee(mProtocolId, this);
     }
   }
 
@@ -442,6 +445,7 @@ class IProtocol : public HasResultCodes {
 
  private:
   int32_t mId;
+  ProtocolId mProtocolId;
   Side mSide;
   LinkStatus mLinkStatus;
   ActorLifecycleProxy* mLifecycleProxy;
@@ -449,8 +453,6 @@ class IProtocol : public HasResultCodes {
   UniquePtr<ProtocolState> mState;
 };
 
-typedef IPCMessageStart ProtocolId;
-
 #define IPC_OK() mozilla::ipc::IPCResult::Ok()
 #define IPC_FAIL(actor, why) \
   mozilla::ipc::IPCResult::Fail(WrapNotNull(actor), __func__, (why))
@@ -553,8 +555,6 @@ class IToplevelProtocol : public IProtocol {
 
   Transport* GetTransport() const { return mTrans.get(); }
 
-  ProtocolId GetProtocolId() const { return mProtocolId; }
-
   base::ProcessId OtherPid() const final;
   void SetOtherProcessId(base::ProcessId aOtherPid);
 
@@ -684,7 +684,6 @@ class IToplevelProtocol : public IProtocol {
  private:
   base::ProcessId OtherPidMaybeInvalid() const;
 
-  ProtocolId mProtocolId;
   UniquePtr<Transport> mTrans;
   base::ProcessId mOtherPid;
   bool mIsMainThreadProtocol;

ipc/ipdl/ipdl/lower.py

@@ -3388,7 +3388,8 @@ class _GenerateProtocolActorCode(ipdl.ast.Visitor):
             ]
         else:
             ctor.memberinits = [
-                ExprMemberInit(ExprVar('mozilla::ipc::IProtocol'), [side])
+                ExprMemberInit(ExprVar('mozilla::ipc::IProtocol'),
+                               [_protocolId(ptype), side])
             ]
 
         ctor.addcode('MOZ_COUNT_CTOR(${clsname});\n', clsname=self.clsname)
@@ -3603,13 +3604,6 @@ class _GenerateProtocolActorCode(ipdl.ast.Visitor):
 
         clearsubtreevar = ExprVar('ClearSubtree')
 
-        # int32_t GetProtocolTypeId() { return PFoo; }
-        gettypetag = MethodDefn(
-            MethodDecl('GetProtocolTypeId', ret=_actorTypeTagType(),
-                       methodspec=MethodSpec.OVERRIDE))
-        gettypetag.addstmt(StmtReturn(_protocolId(ptype)))
-        self.cls.addstmts([gettypetag, Whitespace.NL])
-
         if ptype.isToplevel():
             # OnChannelClose()
             onclose = MethodDefn(MethodDecl('OnChannelClose',

toolkit/recordreplay/ipc/ParentForwarding.cpp

@@ -340,10 +340,6 @@ class MiddlemanProtocol : public ipc::IToplevelProtocol {
     return MsgProcessed;
   }
 
-  virtual int32_t GetProtocolTypeId() override {
-    MOZ_CRASH("MiddlemanProtocol::GetProtocolTypeId");
-  }
-
   virtual void OnChannelClose() override {
     MOZ_RELEASE_ASSERT(mSide == ipc::ChildSide);
     BeginShutdown();