Backed out 5 changesets (bug 1937908) for causing build bustages @ GMPParent.cpp CLOSED TREE

Backed out changeset de6301e43b81 (bug 1937908)
Backed out changeset 4723190b3ae4 (bug 1937908)
Backed out changeset f0b7d22731bc (bug 1937908)
Backed out changeset 1cf5ffd4299a (bug 1937908)
Backed out changeset 866fa8510165 (bug 1937908)

Author: amarc-mozilla

dom/media/gmp/GMPParent.cpp

@@ -81,7 +81,7 @@ GMPParent::GMPParent()
       mChildLaunchArch(base::PROCESS_ARCH_INVALID),
 #endif
       mMainThread(GetMainThreadSerialEventTarget()) {
-  MOZ_ASSERT(GMPEventTarget()->IsOnCurrentThread());
+  MOZ_ASSERT(IsOnGMPEventTarget());
   GMP_PARENT_LOG_DEBUG("GMPParent ctor id=%u", mPluginId);
 }
 
@@ -92,7 +92,7 @@ GMPParent::~GMPParent() {
 }
 
 void GMPParent::CloneFrom(const GMPParent* aOther) {
-  MOZ_ASSERT(GMPEventTarget()->IsOnCurrentThread());
+  MOZ_ASSERT(IsOnGMPEventTarget());
   MOZ_ASSERT(aOther->mDirectory && aOther->mService, "null plugin directory");
 
   mService = aOther->mService;
@@ -169,7 +169,7 @@ RefPtr<GenericPromise> GMPParent::Init(GeckoMediaPluginServiceParent* aService,
                                        nsIFile* aPluginDir) {
   MOZ_ASSERT(aPluginDir);
   MOZ_ASSERT(aService);
-  MOZ_ASSERT(GMPEventTarget()->IsOnCurrentThread());
+  MOZ_ASSERT(IsOnGMPEventTarget());
 
   mService = aService;
   mDirectory = aPluginDir;
@@ -343,7 +343,7 @@ class NotifyGMPProcessLoadedTask : public Runnable {
 
 nsresult GMPParent::LoadProcess() {
   MOZ_ASSERT(mDirectory, "Plugin directory cannot be NULL!");
-  MOZ_ASSERT(GMPEventTarget()->IsOnCurrentThread());
+  MOZ_ASSERT(IsOnGMPEventTarget());
   MOZ_ASSERT(mState == GMPState::NotLoaded);
 
   if (NS_WARN_IF(mPluginType == GMPPluginType::WidevineL1)) {
@@ -433,7 +433,7 @@ nsresult GMPParent::LoadProcess() {
 }
 
 void GMPParent::OnPreferenceChange(const mozilla::dom::Pref& aPref) {
-  MOZ_ASSERT(GMPEventTarget()->IsOnCurrentThread());
+  MOZ_ASSERT(IsOnGMPEventTarget());
   GMP_PARENT_LOG_DEBUG("%s", __FUNCTION__);
 
   if (!mProcess || !mProcess->UseXPCOM()) {
@@ -501,7 +501,7 @@ mozilla::ipc::IPCResult GMPParent::RecvGetModulesTrust(
 #endif  // defined(XP_WIN)
 
 void GMPParent::CloseIfUnused() {
-  MOZ_ASSERT(GMPEventTarget()->IsOnCurrentThread());
+  MOZ_ASSERT(IsOnGMPEventTarget());
   GMP_PARENT_LOG_DEBUG("%s", __FUNCTION__);
 
   if ((mDeleteProcessOnlyOnUnload || mState == GMPState::Loaded ||
@@ -524,7 +524,7 @@ void GMPParent::CloseIfUnused() {
 }
 
 void GMPParent::CloseActive(bool aDieWhenUnloaded) {
-  MOZ_ASSERT(GMPEventTarget()->IsOnCurrentThread());
+  MOZ_ASSERT(IsOnGMPEventTarget());
   GMP_PARENT_LOG_DEBUG("%s: state %u", __FUNCTION__,
                        uint32_t(GMPState(mState)));
 
@@ -548,7 +548,7 @@ void GMPParent::MarkForDeletion() {
 bool GMPParent::IsMarkedForDeletion() { return mIsBlockingDeletion; }
 
 void GMPParent::Shutdown() {
-  MOZ_ASSERT(GMPEventTarget()->IsOnCurrentThread());
+  MOZ_ASSERT(IsOnGMPEventTarget());
   GMP_PARENT_LOG_DEBUG("%s", __FUNCTION__);
 
   if (mAbnormalShutdownInProgress) {
@@ -615,7 +615,7 @@ void GMPParent::ChildTerminated() {
 }
 
 void GMPParent::DeleteProcess() {
-  MOZ_ASSERT(GMPEventTarget()->IsOnCurrentThread());
+  MOZ_ASSERT(IsOnGMPEventTarget());
 
   switch (mState) {
     case GMPState::Closed:
@@ -701,7 +701,17 @@ void GMPParent::DeleteProcess() {
 
 GMPState GMPParent::State() const { return mState; }
 
-nsCOMPtr<nsISerialEventTarget> GMPParent::GMPEventTarget() {
+bool GMPParent::IsOnGMPEventTarget() const {
+  auto target = GMPEventTarget();
+  if (!target) {
+    // We can't get the GMP event target if it has started shutting down, but it
+    // may still run tasks.
+    return AppShutdown::IsInOrBeyond(ShutdownPhase::XPCOMShutdownThreads);
+  }
+  return target->IsOnCurrentThread();
+}
+
+nsCOMPtr<nsISerialEventTarget> GMPParent::GMPEventTarget() const {
   nsCOMPtr<mozIGeckoMediaPluginService> mps =
       do_GetService("@mozilla.org/gecko-media-plugin-service;1");
   MOZ_ASSERT(mps);
@@ -813,9 +823,8 @@ static void GMPNotifyObservers(const uint32_t aPluginID,
 }
 
 void GMPParent::ActorDestroy(ActorDestroyReason aWhy) {
-  MOZ_ASSERT(GMPEventTarget()->IsOnCurrentThread());
-  GMP_PARENT_LOG_DEBUG("%s: (%d), state=%u", __FUNCTION__, (int)aWhy,
-                       static_cast<GMPState>(mState));
+  MOZ_ASSERT(IsOnGMPEventTarget());
+  GMP_PARENT_LOG_DEBUG("%s: (%d)", __FUNCTION__, (int)aWhy);
 
   if (AbnormalShutdown == aWhy) {
     Telemetry::Accumulate(Telemetry::SUBPROCESS_ABNORMAL_ABORT, "gmplugin"_ns,
@@ -840,8 +849,7 @@ void GMPParent::ActorDestroy(ActorDestroyReason aWhy) {
   mAbnormalShutdownInProgress = true;
   CloseActive(false);
 
-  // Normal Shutdown() will delete the process on unwind. GMPProcessParent
-  // blocks shutdown to avoid races.
+  // Normal Shutdown() will delete the process on unwind.
   if (AbnormalShutdown == aWhy) {
     RefPtr<GMPParent> self(this);
     // Must not call Close() again in DeleteProcess(), as we'll recurse
@@ -908,7 +916,7 @@ bool ReadInfoField(GMPInfoFileParser& aParser, const nsCString& aKey,
 }
 
 RefPtr<GenericPromise> GMPParent::ReadGMPMetaData() {
-  MOZ_ASSERT(GMPEventTarget()->IsOnCurrentThread());
+  MOZ_ASSERT(IsOnGMPEventTarget());
   MOZ_ASSERT(mDirectory, "Plugin directory cannot be NULL!");
   MOZ_ASSERT(!mName.IsEmpty(), "Plugin mName cannot be empty!");
 
@@ -997,7 +1005,7 @@ static nsresult ParseVersion(const nsACString& aVersion,
 }
 
 RefPtr<GenericPromise> GMPParent::ReadGMPInfoFile(nsIFile* aFile) {
-  MOZ_ASSERT(GMPEventTarget()->IsOnCurrentThread());
+  MOZ_ASSERT(IsOnGMPEventTarget());
   GMPInfoFileParser parser;
   if (!parser.Init(aFile)) {
     return GenericPromise::CreateAndReject(NS_ERROR_FAILURE, __func__);
@@ -1105,7 +1113,7 @@ RefPtr<GenericPromise> GMPParent::ReadGMPInfoFile(nsIFile* aFile) {
 }
 
 RefPtr<GenericPromise> GMPParent::ReadChromiumManifestFile(nsIFile* aFile) {
-  MOZ_ASSERT(GMPEventTarget()->IsOnCurrentThread());
+  MOZ_ASSERT(IsOnGMPEventTarget());
   nsAutoCString json;
   if (!ReadIntoString(aFile, json, 5 * 1024)) {
     return GenericPromise::CreateAndReject(NS_ERROR_FAILURE, __func__);
@@ -1335,7 +1343,7 @@ void GMPParent::ResolveGetContentParentPromises() {
 }
 
 bool GMPParent::OpenPGMPContent() {
-  MOZ_ASSERT(GMPEventTarget()->IsOnCurrentThread());
+  MOZ_ASSERT(IsOnGMPEventTarget());
   MOZ_ASSERT(!mGMPContentParent);
 
   Endpoint<PGMPContentParent> parent;
@@ -1372,7 +1380,7 @@ void GMPParent::RejectGetContentParentPromises() {
 
 void GMPParent::GetGMPContentParent(
     UniquePtr<MozPromiseHolder<GetGMPContentParentPromise>>&& aPromiseHolder) {
-  MOZ_ASSERT(GMPEventTarget()->IsOnCurrentThread());
+  MOZ_ASSERT(IsOnGMPEventTarget());
   GMP_PARENT_LOG_DEBUG("%s %p", __FUNCTION__, this);
 
   if (mGMPContentParent) {

dom/media/gmp/GMPParent.h

@@ -91,7 +91,8 @@ class GMPParent final
   void DeleteProcess();
 
   GMPState State() const;
-  nsCOMPtr<nsISerialEventTarget> GMPEventTarget();
+  bool IsOnGMPEventTarget() const;
+  nsCOMPtr<nsISerialEventTarget> GMPEventTarget() const;
 
   void OnPreferenceChange(const mozilla::dom::Pref& aPref);
 
@@ -129,6 +130,8 @@ class GMPParent final
     return nsCOMPtr<nsIFile>(mDirectory).forget();
   }
 
+  void AbortAsyncShutdown();
+
   // Called when the child process has died.
   void ChildTerminated();
 

dom/media/gmp/GMPProcessParent.cpp

@@ -15,7 +15,6 @@
 #include "mozilla/ipc/ProcessChild.h"
 #include "mozilla/ipc/ProcessUtils.h"
 #include "mozilla/StaticPrefs_media.h"
-#include "nsFmtString.h"
 
 #include "base/string_util.h"
 #include "base/process_util.h"
@@ -233,14 +232,7 @@ bool GMPProcessParent::Launch(int32_t aTimeoutMs) {
   // We need to wait until OnChannelConnected to clear the pref serializer, but
   // SyncLaunch will block until that is called, so we don't actually need to do
   // any overriding, and it only lives on the stack.
-  bool launched = SyncLaunch(std::move(args), aTimeoutMs);
-  if (launched) {
-    nsFmtString name{FMT_STRING(u"GMPProcessParent {}"),
-                     static_cast<void*>(this)};
-    mShutdownBlocker = media::ShutdownBlockingTicket::Create(
-        name, NS_LITERAL_STRING_FROM_CSTRING(__FILE__), __LINE__);
-  }
-  return launched;
+  return SyncLaunch(std::move(args), aTimeoutMs);
 }
 
 void GMPProcessParent::Delete(nsCOMPtr<nsIRunnable> aCallback) {

dom/media/gmp/GMPProcessParent.h

@@ -12,7 +12,6 @@
 #include "base/file_path.h"
 #include "base/thread.h"
 #include "mozilla/ipc/GeckoChildProcessHost.h"
-#include "mozilla/media/MediaUtils.h"
 #include "nsIFile.h"
 
 class nsIRunnable;
@@ -90,9 +89,6 @@ class GMPProcessParent final : public mozilla::ipc::GeckoChildProcessHost {
 #  endif
 #endif
 
-  // Ticket for blocking shutdown while the process is live.
-  UniquePtr<media::ShutdownBlockingTicket> mShutdownBlocker;
-
   // For normalizing paths to be compatible with sandboxing.
   // We use normalized paths to generate the sandbox ruleset. Once
   // the sandbox has been started, resolving symlinks that point to

dom/media/gmp/GMPService.cpp

@@ -370,6 +370,25 @@ void GeckoMediaPluginService::ShutdownGMPThread() {
   }
 }
 
+/* static */
+nsCOMPtr<nsIAsyncShutdownClient> GeckoMediaPluginService::GetShutdownBarrier() {
+  nsCOMPtr<nsIAsyncShutdownService> svc = services::GetAsyncShutdownService();
+  if (NS_WARN_IF(!svc)) {
+    MOZ_ASSERT_UNREACHABLE("No async shutdown service!");
+    return nullptr;
+  }
+
+  nsCOMPtr<nsIAsyncShutdownClient> barrier;
+  nsresult rv = svc->GetXpcomWillShutdown(getter_AddRefs(barrier));
+  if (NS_WARN_IF(NS_FAILED(rv))) {
+    MOZ_ASSERT_UNREACHABLE("Could not create shutdown barrier!");
+    return nullptr;
+  }
+
+  MOZ_RELEASE_ASSERT(barrier);
+  return barrier;
+}
+
 nsresult GeckoMediaPluginService::GMPDispatch(nsIRunnable* event,
                                               uint32_t flags) {
   nsCOMPtr<nsIRunnable> r(event);

dom/media/gmp/GMPServiceChild.cpp

@@ -18,7 +18,6 @@
 #include "mozilla/ipc/Endpoint.h"
 #include "nsCOMPtr.h"
 #include "nsComponentManagerUtils.h"
-#include "nsFmtString.h"
 #include "nsIObserverService.h"
 #include "nsReadableUtils.h"
 #include "nsXPCOMPrivate.h"
@@ -63,8 +62,37 @@ nsresult GeckoMediaPluginServiceChild::Init() {
   return GeckoMediaPluginService::Init();
 }
 
-NS_IMPL_ISUPPORTS_INHERITED0(GeckoMediaPluginServiceChild,
-                             GeckoMediaPluginService)
+NS_IMPL_ISUPPORTS_INHERITED(GeckoMediaPluginServiceChild,
+                            GeckoMediaPluginService, nsIAsyncShutdownBlocker)
+
+// Used to identify blockers that we put in place.
+static const nsLiteralString kShutdownBlockerName =
+    u"GeckoMediaPluginServiceChild: shutdown"_ns;
+
+// nsIAsyncShutdownBlocker members
+NS_IMETHODIMP
+GeckoMediaPluginServiceChild::GetName(nsAString& aName) {
+  aName = kShutdownBlockerName;
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+GeckoMediaPluginServiceChild::GetState(nsIPropertyBag**) { return NS_OK; }
+
+NS_IMETHODIMP
+GeckoMediaPluginServiceChild::BlockShutdown(nsIAsyncShutdownClient*) {
+  MOZ_ASSERT(NS_IsMainThread());
+  GMP_LOG_DEBUG("%s::%s", __CLASS__, __FUNCTION__);
+
+  mXPCOMWillShutdown = true;
+
+  MutexAutoLock lock(mMutex);
+  Unused << NS_WARN_IF(NS_FAILED(mGMPThread->Dispatch(
+      NewRunnableMethod("GeckoMediaPluginServiceChild::BeginShutdown", this,
+                        &GeckoMediaPluginServiceChild::BeginShutdown))));
+  return NS_OK;
+}
+// End nsIAsyncShutdownBlocker members
 
 GeckoMediaPluginServiceChild::~GeckoMediaPluginServiceChild() {
   MOZ_ASSERT(!mServiceChild);
@@ -452,28 +480,21 @@ nsresult GeckoMediaPluginServiceChild::AddShutdownBlocker() {
   MOZ_ASSERT(NS_IsMainThread());
   MOZ_ASSERT(!mShuttingDownOnGMPThread,
              "No call paths should add blockers once we're shutting down!");
-  MOZ_ASSERT(!mShutdownBlocker, "Should only add blocker once!");
+  MOZ_ASSERT(!mShutdownBlockerAdded, "Should only add blocker once!");
   GMP_LOG_DEBUG("%s::%s ", __CLASS__, __FUNCTION__);
 
-  nsFmtString name(u"GeckoMediaPluginServiceChild {}",
-                   static_cast<void*>(this));
-  mShutdownBlocker = media::ShutdownBlockingTicket::Create(
-      name, NS_LITERAL_STRING_FROM_CSTRING(__FILE__), __LINE__);
-  if (mShutdownBlocker) {
-    mShutdownBlocker->ShutdownPromise()->Then(
-        mMainThread, __func__, [this, self = RefPtr(this), name]() {
-          GMP_LOG_DEBUG("GMPServiceChild::BlockShutdown: %s",
-                        NS_ConvertUTF16toUTF8(name).get());
-          mXPCOMWillShutdown = true;
-          nsCOMPtr gmpThread = GetGMPThread();
-          gmpThread->Dispatch(
-              NewRunnableMethod("GMPServiceChild::BeginShutdown", this,
-                                &GeckoMediaPluginServiceChild::BeginShutdown));
-        });
-    return NS_OK;
+  nsCOMPtr<nsIAsyncShutdownClient> barrier = GetShutdownBarrier();
+  if (NS_WARN_IF(!barrier)) {
+    return NS_ERROR_NOT_AVAILABLE;
   }
 
-  return NS_ERROR_FAILURE;
+  nsresult rv =
+      barrier->AddBlocker(this, NS_LITERAL_STRING_FROM_CSTRING(__FILE__),
+                          __LINE__, kShutdownBlockerName);
+#ifdef DEBUG
+  mShutdownBlockerAdded = NS_SUCCEEDED(rv);
+#endif
+  return rv;
 }
 
 void GeckoMediaPluginServiceChild::RemoveShutdownBlocker() {
@@ -482,7 +503,23 @@ void GeckoMediaPluginServiceChild::RemoveShutdownBlocker() {
              "We should only remove blockers once we're "
              "shutting down!");
   GMP_LOG_DEBUG("%s::%s ", __CLASS__, __FUNCTION__);
-  mShutdownBlocker = nullptr;
+  nsresult rv = mMainThread->Dispatch(NS_NewRunnableFunction(
+      "GeckoMediaPluginServiceChild::"
+      "RemoveShutdownBlocker",
+      [this, self = RefPtr<GeckoMediaPluginServiceChild>(this)]() {
+        nsCOMPtr<nsIAsyncShutdownClient> barrier = GetShutdownBarrier();
+        if (NS_WARN_IF(!barrier)) {
+          return;
+        }
+
+        nsresult rv = barrier->RemoveBlocker(this);
+        MOZ_RELEASE_ASSERT(NS_SUCCEEDED(rv));
+      }));
+  if (NS_WARN_IF(NS_FAILED(rv))) {
+    MOZ_ASSERT_UNREACHABLE(
+        "Main thread should always be alive when we "
+        "call this!");
+  }
 }
 
 void GeckoMediaPluginServiceChild::RemoveShutdownBlockerIfNeeded() {