dom/ipc/ContentProcessManager.cpp

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   5  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "ContentProcessManager.h"
   8 #include "ContentParent.h"
   9 #include "mozilla/AppShutdown.h"
  10 #include "mozilla/dom/BrowserParent.h"
  11 #include "mozilla/dom/BrowsingContextGroup.h"
  12 #include "mozilla/dom/CanonicalBrowsingContext.h"
  13
  14 #include "mozilla/StaticPtr.h"
  15 #include "mozilla/ClearOnShutdown.h"
  16
  17 #include "nsPrintfCString.h"
  18
  19 namespace mozilla::dom {
  20
  21 /* static */
  22 StaticAutoPtr<ContentProcessManager> ContentProcessManager::sSingleton;
  23
  24 /* static */
  25 ContentProcessManager* ContentProcessManager::GetSingleton() {
  26   MOZ_ASSERT(XRE_IsParentProcess());
  27
  28   if (!sSingleton &&
  29       !AppShutdown::IsInOrBeyond(ShutdownPhase::XPCOMShutdownFinal)) {
  30     sSingleton = new ContentProcessManager();
  31     ClearOnShutdown(&sSingleton);
  32   }
  33   return sSingleton;
  34 }
  35
  36 void ContentProcessManager::AddContentProcess(ContentParent* aChildCp) {
  37   MOZ_ASSERT(NS_IsMainThread());
  38   MOZ_ASSERT(aChildCp);
  39
  40   mContentParentMap.WithEntryHandle(aChildCp->ChildID(), [&](auto&& entry) {
  41     MOZ_ASSERT_IF(entry, entry.Data() == aChildCp);
  42     entry.OrInsert(aChildCp);
  43   });
  44 }
  45
  46 void ContentProcessManager::RemoveContentProcess(
  47     const ContentParentId& aChildCpId) {
  48   MOZ_ASSERT(NS_IsMainThread());
  49
  50   MOZ_ALWAYS_TRUE(mContentParentMap.Remove(aChildCpId));
  51 }
  52
  53 ContentParent* ContentProcessManager::GetContentProcessById(
  54     const ContentParentId& aChildCpId) {
  55   MOZ_ASSERT(NS_IsMainThread());
  56
  57   ContentParent* contentParent = mContentParentMap.Get(aChildCpId);
  58   if (NS_WARN_IF(!contentParent)) {
  59     return nullptr;
  60   }
  61   return contentParent;
  62 }
  63
  64 bool ContentProcessManager::RegisterRemoteFrame(BrowserParent* aChildBp) {
  65   MOZ_ASSERT(NS_IsMainThread());
  66   MOZ_ASSERT(aChildBp);
  67
  68   return mBrowserParentMap.WithEntryHandle(
  69       aChildBp->GetTabId(), [&](auto&& entry) {
  70         if (entry) {
  71           MOZ_ASSERT(entry.Data() == aChildBp);
  72           return false;
  73         }
  74
  75         // Ensure that this BrowserParent's BrowsingContextGroup is kept alive
  76         // until the BrowserParent has been unregistered, ensuring the group
  77         // isn't destroyed while this BrowserParent can still send messages.
  78         aChildBp->GetBrowsingContext()->Group()->AddKeepAlive();
  79         entry.Insert(aChildBp);
  80         return true;
  81       });
  82 }
  83
  84 void ContentProcessManager::UnregisterRemoteFrame(const TabId& aChildTabId) {
  85   MOZ_ASSERT(NS_IsMainThread());
  86
  87   auto childBp = mBrowserParentMap.Extract(aChildTabId);
  88   MOZ_DIAGNOSTIC_ASSERT(childBp);
  89
  90   // Clear the corresponding keepalive which was added in `RegisterRemoteFrame`.
  91   (*childBp)->GetBrowsingContext()->Group()->RemoveKeepAlive();
  92 }
  93
  94 ContentParentId ContentProcessManager::GetTabProcessId(
  95     const TabId& aChildTabId) {
  96   MOZ_ASSERT(NS_IsMainThread());
  97
  98   if (BrowserParent* browserParent = mBrowserParentMap.Get(aChildTabId)) {
  99     return browserParent->Manager()->ChildID();
 100   }
 101   return ContentParentId(0);
 102 }
 103
 104 uint32_t ContentProcessManager::GetBrowserParentCountByProcessId(
 105     const ContentParentId& aChildCpId) {
 106   MOZ_ASSERT(NS_IsMainThread());
 107
 108   ContentParent* contentParent = mContentParentMap.Get(aChildCpId);
 109   if (NS_WARN_IF(!contentParent)) {
 110     return 0;
 111   }
 112   return contentParent->ManagedPBrowserParent().Count();
 113 }
 114
 115 already_AddRefed<BrowserParent>
 116 ContentProcessManager::GetBrowserParentByProcessAndTabId(
 117     const ContentParentId& aChildCpId, const TabId& aChildTabId) {
 118   RefPtr<BrowserParent> browserParent = mBrowserParentMap.Get(aChildTabId);
 119   if (NS_WARN_IF(!browserParent)) {
 120     return nullptr;
 121   }
 122
 123   if (NS_WARN_IF(browserParent->Manager()->ChildID() != aChildCpId)) {
 124     return nullptr;
 125   }
 126
 127   return browserParent.forget();
 128 }
 129
 130 already_AddRefed<BrowserParent>
 131 ContentProcessManager::GetTopLevelBrowserParentByProcessAndTabId(
 132     const ContentParentId& aChildCpId, const TabId& aChildTabId) {
 133   RefPtr<BrowserParent> browserParent =
 134       GetBrowserParentByProcessAndTabId(aChildCpId, aChildTabId);
 135   while (browserParent && browserParent->GetBrowserBridgeParent()) {
 136     browserParent = browserParent->GetBrowserBridgeParent()->Manager();
 137   }
 138
 139   return browserParent.forget();
 140 }
 141
 142 }  // namespace mozilla::dom