Bug 1689953: Harmonize shutdown phase definitions across nsTerminator…

… and AppShutdown r=dthayer,chutten

This patch wants to solve several quirks around the shutdown terminator.

 - Use the same shutdown phase definitions in AppShutdown and nsTerminator. This touches quite a few files.
 - Ensure that the terminator phase shift is handled before any shutdown observer notifications are sent and reduce its heartbeat duration.
 - Add missing phases to the shutdown telemetry.

Please note that this changes the unit of "tick" to 100ms rather than 1s.
As a side effect, we also remove the obsolete "shutdown-persist" context.

While the existing test coverage continues to prove the most important functions, we acknowledge the wish for better test coverage with [[ https://bugzilla.mozilla.org/show_bug.cgi?id=1693966 | bug 1693966 ]].

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

accessible/ipc/win/DocAccessibleChild.cpp

@@ -22,7 +22,7 @@ DocAccessibleChild::DocAccessibleChild(DocAccessible* aDoc, IProtocol* aManager)
   MOZ_COUNT_CTOR_INHERITED(DocAccessibleChild, DocAccessibleChildBase);
   if (!sPlatformChild) {
     sPlatformChild = new PlatformChild();
-    ClearOnShutdown(&sPlatformChild, ShutdownPhase::Shutdown);
+    ClearOnShutdown(&sPlatformChild, ShutdownPhase::XPCOMShutdown);
   }
 
   SetManager(aManager);

browser/components/enterprisepolicies/tests/browser/browser_policy_cookie_settings.js

@@ -28,7 +28,7 @@ async function fake_profile_change() {
     }, "cookie-db-closed");
     Services.cookies
       .QueryInterface(Ci.nsIObserver)
-      .observe(null, "profile-before-change", "shutdown-persist");
+      .observe(null, "profile-before-change", null);
   });
   await new Promise(resolve => {
     Services.obs.addObserver(function waitForDBOpen() {

dom/ipc/ContentChild.cpp

@@ -575,7 +575,7 @@ ContentChild::ContentChild()
   // happens without requiring the observer service at this time.
   if (!sShutdownCanary) {
     sShutdownCanary = new ShutdownCanary();
-    ClearOnShutdown(&sShutdownCanary, ShutdownPhase::Shutdown);
+    ClearOnShutdown(&sShutdownCanary, ShutdownPhase::XPCOMShutdown);
   }
 }
 

dom/ipc/ContentParent.cpp

@@ -2839,7 +2839,7 @@ bool ContentParent::InitInternal(ProcessPriority aInitialPriority) {
   // can't init the process without it, and since we're going to be canceling
   // whatever load attempt that initiated this process creation anyway, just
   // bail out now if shutdown has already started.
-  if (PastShutdownPhase(ShutdownPhase::Shutdown)) {
+  if (PastShutdownPhase(ShutdownPhase::XPCOMShutdown)) {
     return false;
   }
 

dom/media/MediaCache.cpp

@@ -773,7 +773,7 @@ RefPtr<MediaCache> MediaCache::GetMediaCache(int64_t aContentLength,
         thread->Shutdown();
       }
     } sClearThread;
-    ClearOnShutdown(&sClearThread, ShutdownPhase::ShutdownThreads);
+    ClearOnShutdown(&sClearThread, ShutdownPhase::XPCOMShutdownThreads);
   }
 
   if (!sThread) {

dom/media/doctor/DecoderDoctorLogger.cpp

@@ -116,9 +116,11 @@ bool DecoderDoctorLogger::EnsureLogIsEnabled() {
               TaskCategory::Other,
               NS_NewRunnableFunction("DDLogger shutdown setup", [] {
                 sDDLogShutdowner = MakeUnique<DDLogShutdowner>();
-                ClearOnShutdown(&sDDLogShutdowner, ShutdownPhase::Shutdown);
+                ClearOnShutdown(&sDDLogShutdowner,
+                                ShutdownPhase::XPCOMShutdown);
                 sDDLogDeleter = MakeUnique<DDLogDeleter>();
-                ClearOnShutdown(&sDDLogDeleter, ShutdownPhase::ShutdownThreads);
+                ClearOnShutdown(&sDDLogDeleter,
+                                ShutdownPhase::XPCOMShutdownThreads);
               })));
 
           // Nobody else should change the state when *we* are enabling logging.

dom/media/mediacapabilities/MediaCapabilities.cpp

@@ -257,7 +257,7 @@ already_AddRefed<Promise> MediaCapabilities::DecodingInfo(
                 NS_NewRunnableFunction(
                     "MediaCapabilities::AllocPolicy:Video", []() {
                       ClearOnShutdown(&sVideoAllocPolicy,
-                                      ShutdownPhase::ShutdownThreads);
+                                      ShutdownPhase::XPCOMShutdownThreads);
                     }));
             return new SingleAllocPolicy(TrackInfo::TrackType::kVideoTrack,
                                          taskQueue);

dom/media/platforms/AllocationPolicy.cpp

@@ -97,7 +97,8 @@ NotNull<AllocPolicy*> GlobalAllocPolicy::Instance(TrackType aTrack) {
           TaskCategory::Other,
           NS_NewRunnableFunction(
               "GlobalAllocPolicy::GlobalAllocPolicy:Audio", []() {
-                ClearOnShutdown(&sAudioPolicy, ShutdownPhase::ShutdownThreads);
+                ClearOnShutdown(&sAudioPolicy,
+                                ShutdownPhase::XPCOMShutdownThreads);
               }));
       return new AllocPolicyImpl(MediaDecoderLimitDefault());
     }();
@@ -108,7 +109,8 @@ NotNull<AllocPolicy*> GlobalAllocPolicy::Instance(TrackType aTrack) {
         TaskCategory::Other,
         NS_NewRunnableFunction(
             "GlobalAllocPolicy::GlobalAllocPolicy:Audio", []() {
-              ClearOnShutdown(&sVideoPolicy, ShutdownPhase::ShutdownThreads);
+              ClearOnShutdown(&sVideoPolicy,
+                              ShutdownPhase::XPCOMShutdownThreads);
             }));
     return new AllocPolicyImpl(MediaDecoderLimitDefault());
   }();

dom/media/webrtc/CubebDeviceEnumerator.cpp

@@ -30,7 +30,7 @@ CubebDeviceEnumerator* CubebDeviceEnumerator::GetInstance() {
     sInstance = new CubebDeviceEnumerator();
     static bool clearOnShutdownSetup = []() -> bool {
       auto setClearOnShutdown = []() -> void {
-        ClearOnShutdown(&sInstance, ShutdownPhase::ShutdownThreads);
+        ClearOnShutdown(&sInstance, ShutdownPhase::XPCOMShutdownThreads);
       };
       if (NS_IsMainThread()) {
         setClearOnShutdown();

dom/media/webrtc/transport/nr_socket_prsock.cpp

@@ -241,7 +241,7 @@ class SingletonThreadHolder final {
 static StaticRefPtr<SingletonThreadHolder> sThread;
 
 static void ClearSingletonOnShutdown() {
-  ClearOnShutdown(&sThread, ShutdownPhase::ShutdownLoaders);
+  ClearOnShutdown(&sThread, ShutdownPhase::XPCOMShutdownLoaders);
 }
 #endif
 

dom/plugins/ipc/PluginProcessChild.cpp

@@ -176,7 +176,7 @@ void PluginProcessChild::CleanUp() {
   NS_LogTerm();
 #endif
 
-  mozilla::KillClearOnShutdown(ShutdownPhase::ShutdownFinal);
+  mozilla::KillClearOnShutdown(ShutdownPhase::XPCOMShutdownFinal);
 
   AbstractThread::ShutdownMainThread();
 

dom/storage/SessionStorageManager.cpp

@@ -625,7 +625,7 @@ BackgroundSessionStorageManager* BackgroundSessionStorageManager::GetOrCreate(
                   return;
                 }
               },
-              ShutdownPhase::Shutdown);
+              ShutdownPhase::XPCOMShutdown);
         }));
   }
 

dom/webauthn/U2FTokenManager.cpp

@@ -89,7 +89,7 @@ class U2FPrefManager final : public nsIObserver {
                                      PREF_WEBAUTHN_ANDROID_FIDO2_ENABLED);
       Preferences::AddStrongObserver(gPrefManager,
                                      PREF_WEBAUTHN_ALLOW_DIRECT_ATTESTATION);
-      ClearOnShutdown(&gPrefManager, ShutdownPhase::ShutdownThreads);
+      ClearOnShutdown(&gPrefManager, ShutdownPhase::XPCOMShutdownThreads);
     }
     return gPrefManager;
   }

gfx/vr/VRManager.cpp

@@ -161,7 +161,7 @@ VRManager::VRManager()
   VRServiceHost::Init(mVRProcessEnabled);
   mServiceHost = VRServiceHost::Get();
   // We must shutdown before VRServiceHost, which is cleared
-  // on ShutdownPhase::ShutdownFinal, potentially before VRManager.
+  // on ShutdownPhase::XPCOMShutdownFinal, potentially before VRManager.
   // We hold a reference to VRServiceHost to ensure it stays
   // alive until we have shut down.
 #else

gfx/vr/VRServiceHost.cpp

@@ -240,7 +240,8 @@ void VRServiceHost::PuppetReset() {
   // If we're already into ShutdownFinal, the VRPuppetCommandBuffer instance
   // will have been cleared, so don't try to access it after that point.
   if (!mVRProcessEnabled &&
-      !(NS_IsMainThread() && PastShutdownPhase(ShutdownPhase::ShutdownFinal))) {
+      !(NS_IsMainThread() &&
+        PastShutdownPhase(ShutdownPhase::XPCOMShutdownFinal))) {
     // Puppet is running in this process, tell it to reset directly.
     VRPuppetCommandBuffer::Get().Reset();
   }

intl/locale/LocaleService.cpp

@@ -152,7 +152,7 @@ LocaleService* LocaleService::GetInstance() {
     }
     // DOM might use ICUUtils and LocaleService during UnbindFromTree by
     // final cycle collection.
-    ClearOnShutdown(&sInstance, ShutdownPhase::ShutdownPostLastCycleCollection);
+    ClearOnShutdown(&sInstance, ShutdownPhase::CCPostLastCycleCollection);
   }
   return sInstance;
 }

intl/strres/nsStringBundle.cpp

@@ -472,7 +472,7 @@ nsresult nsStringBundleBase::ParseProperties(nsIPersistentProperties** aProps) {
 nsresult nsStringBundle::LoadProperties() {
   // Something such as Necko might use string bundle after ClearOnShutdown is
   // called. LocaleService etc is already down, so we cannot get bundle data.
-  if (PastShutdownPhase(ShutdownPhase::Shutdown)) {
+  if (PastShutdownPhase(ShutdownPhase::XPCOMShutdown)) {
     return NS_ERROR_ILLEGAL_DURING_SHUTDOWN;
   }
 
@@ -500,7 +500,7 @@ nsresult SharedStringBundle::LoadProperties() {
   // our string bundles come from). Since shared string bundles won't be
   // useful after shutdown has started anyway (and we almost certainly got
   // here from a pre-load attempt in an idle task), just bail out.
-  if (PastShutdownPhase(ShutdownPhase::Shutdown)) {
+  if (PastShutdownPhase(ShutdownPhase::XPCOMShutdown)) {
     return NS_ERROR_ILLEGAL_DURING_SHUTDOWN;
   }
 

ipc/mscom/EnsureMTA.cpp

@@ -126,7 +126,7 @@ nsCOMPtr<nsIThread> EnsureMTA::GetMTAThread() {
         BackgroundMTAData* bgData = new BackgroundMTAData();
 
         auto setClearOnShutdown = [ptr = &sMTAData]() -> void {
-          ClearOnShutdown(ptr, ShutdownPhase::ShutdownThreads);
+          ClearOnShutdown(ptr, ShutdownPhase::XPCOMShutdownThreads);
         };
 
         if (NS_IsMainThread()) {

ipc/mscom/Registration.cpp

@@ -500,7 +500,7 @@ void RegisterArrayData(const ArrayData* aArrayData, size_t aLength) {
 
   if (!sArrayData) {
     sArrayData = new Vector<std::pair<const ArrayData*, size_t>>();
-    ClearOnShutdown(&sArrayData, ShutdownPhase::ShutdownThreads);
+    ClearOnShutdown(&sArrayData, ShutdownPhase::XPCOMShutdownThreads);
   }
 
   MOZ_ALWAYS_TRUE(sArrayData->emplaceBack(std::make_pair(aArrayData, aLength)));

js/xpconnect/loader/mozJSComponentLoader.cpp

@@ -1220,7 +1220,7 @@ nsresult mozJSComponentLoader::Import(JSContext* aCx,
       !mInProgressImports.Get(info.Key(), &mod)) {
     // We're trying to import a new JSM, but we're late in shutdown and this
     // will likely not succeed and might even crash, so fail here.
-    if (PastShutdownPhase(ShutdownPhase::ShutdownFinal)) {
+    if (PastShutdownPhase(ShutdownPhase::XPCOMShutdownFinal)) {
       return NS_ERROR_ILLEGAL_DURING_SHUTDOWN;
     }
 

netwerk/protocol/http/nsHttpHandler.cpp

@@ -172,8 +172,7 @@ already_AddRefed<nsHttpHandler> nsHttpHandler::GetInstance() {
     MOZ_ASSERT(NS_SUCCEEDED(rv));
     // There is code that may be executed during the final cycle collection
     // shutdown and still referencing gHttpHandler.
-    ClearOnShutdown(&gHttpHandler,
-                    ShutdownPhase::ShutdownPostLastCycleCollection);
+    ClearOnShutdown(&gHttpHandler, ShutdownPhase::CCPostLastCycleCollection);
   }
   RefPtr<nsHttpHandler> httpHandler = gHttpHandler;
   return httpHandler.forget();

netwerk/test/unit/head_cookies.js

@@ -100,7 +100,7 @@ function do_close_profile(generator) {
 
   // Close the db.
   let service = Services.cookies.QueryInterface(Ci.nsIObserver);
-  service.observe(null, "profile-before-change", "shutdown-persist");
+  service.observe(null, "profile-before-change", null);
 }
 
 function _promise_observer(topic) {
@@ -131,7 +131,7 @@ function promise_close_profile() {
 
   // Close the db.
   let service = Services.cookies.QueryInterface(Ci.nsIObserver);
-  service.observe(null, "profile-before-change", "shutdown-persist");
+  service.observe(null, "profile-before-change", null);
 
   return promise;
 }

toolkit/components/extensions/webrequest/ChannelWrapper.cpp

@@ -100,7 +100,7 @@ static LinkedList<ChannelWrapper>& ChannelList() {
   static UniquePtr<ChannelListHolder> sChannelList;
   if (!sChannelList) {
     sChannelList.reset(new ChannelListHolder());
-    ClearOnShutdown(&sChannelList, ShutdownPhase::Shutdown);
+    ClearOnShutdown(&sChannelList, ShutdownPhase::XPCOMShutdown);
   }
   return *sChannelList;
 }

toolkit/components/startup/nsAppStartup.cpp

@@ -441,11 +441,10 @@ nsAppStartup::Quit(uint32_t aMode, int aExitCode, bool* aUserAllowedQuit) {
 
     // No chance of the shutdown being cancelled from here on; tell people
     // we're shutting down for sure while all services are still available.
-    if (obsService) {
-      bool isRestarting = mozilla::AppShutdown::IsRestarting();
-      obsService->NotifyObservers(nullptr, "quit-application",
-                                  isRestarting ? u"restart" : u"shutdown");
-    }
+    bool isRestarting = mozilla::AppShutdown::IsRestarting();
+    mozilla::AppShutdown::AdvanceShutdownPhase(
+        mozilla::ShutdownPhase::AppShutdownConfirmed,
+        isRestarting ? u"restart" : u"shutdown");
 
     if (!mRunning) {
       postedExitEvent = true;

toolkit/components/telemetry/Histograms.json

@@ -12632,34 +12632,75 @@
     "kind": "exponential",
     "high": 65,
     "n_buckets": 10,
+    "bug_numbers": [1689953],
+    "alert_emails": ["[email protected], [email protected]"],
     "description": "Duration of shutdown phase quit-application, as measured by the shutdown terminator, in seconds of activity"
   },
+  "SHUTDOWN_PHASE_DURATION_TICKS_PROFILE_CHANGE_NET_TEARDOWN": {
+    "record_in_processes": ["main", "content"],
+    "products": ["firefox", "fennec", "thunderbird"],
+    "expires_in_version": "never",
+    "kind": "exponential",
+    "high": 65,
+    "n_buckets": 10,
+    "bug_numbers": [1689953],
+    "alert_emails": ["[email protected], [email protected]"],
+    "description": "Duration of shutdown phase profile-change-net-teardown, as measured by the shutdown terminator, in seconds of activity"
+  },
   "SHUTDOWN_PHASE_DURATION_TICKS_PROFILE_CHANGE_TEARDOWN": {
     "record_in_processes": ["main", "content"],
     "products": ["firefox", "fennec", "thunderbird"],
     "expires_in_version": "never",
     "kind": "exponential",
     "high": 65,
     "n_buckets": 10,
+    "bug_numbers": [1689953],
+    "alert_emails": ["[email protected], [email protected]"],
     "description": "Duration of shutdown phase profile-change-teardown, as measured by the shutdown terminator, in seconds of activity"
   },
+  "SHUTDOWN_PHASE_DURATION_TICKS_PROFILE_BEFORE_CHANGE": {
+    "record_in_processes": ["main", "content"],
+    "products": ["firefox", "fennec", "thunderbird"],
+    "expires_in_version": "never",
+    "kind": "exponential",
+    "high": 65,
+    "n_buckets": 10,
+    "bug_numbers": [1689953],
+    "alert_emails": ["[email protected], [email protected]"],
+    "description": "Duration of shutdown phase profile-before-change, as measured by the shutdown terminator, in seconds of activity"
+  },
+  "SHUTDOWN_PHASE_DURATION_TICKS_PROFILE_BEFORE_CHANGE_QM": {
+    "record_in_processes": ["main", "content"],
+    "products": ["firefox", "fennec", "thunderbird"],
+    "expires_in_version": "never",
+    "kind": "exponential",
+    "high": 65,
+    "n_buckets": 10,
+    "bug_numbers": [1689953],
+    "alert_emails": ["[email protected], [email protected]"],
+    "description": "Duration of shutdown phase profile-before-change-qm, as measured by the shutdown terminator, in seconds of activity"
+  },
   "SHUTDOWN_PHASE_DURATION_TICKS_XPCOM_WILL_SHUTDOWN": {
     "record_in_processes": ["main", "content"],
     "products": ["firefox", "fennec", "thunderbird"],
     "expires_in_version": "never",
     "kind": "exponential",
     "high": 65,
     "n_buckets": 10,
+    "bug_numbers": [1689953],
+    "alert_emails": ["[email protected], [email protected]"],
     "description": "Duration of shutdown phase xpcom-will-shutdown, as measured by the shutdown terminator, in seconds of activity"
   },
-  "SHUTDOWN_PHASE_DURATION_TICKS_PROFILE_BEFORE_CHANGE": {
+  "SHUTDOWN_PHASE_DURATION_TICKS_XPCOM_SHUTDOWN": {
     "record_in_processes": ["main", "content"],
     "products": ["firefox", "fennec", "thunderbird"],
     "expires_in_version": "never",
     "kind": "exponential",
     "high": 65,
     "n_buckets": 10,
-    "description": "Duration of shutdown phase profile-before-change, as measured by the shutdown terminator, in seconds of activity"
+    "bug_numbers": [1689953],
+    "alert_emails": ["[email protected], [email protected]"],
+    "description": "Duration of shutdown phase xpcom-shutdown, as measured by the shutdown terminator, in seconds of activity"
   },
   "TAP_TO_LOAD_ENABLED": {
     "record_in_processes": ["main", "content"],

toolkit/components/telemetry/histogram-allowlists.json

@@ -316,10 +316,6 @@
     "SERVICE_WORKER_WAS_SPAWNED",
     "SHOULD_AUTO_DETECT_LANGUAGE",
     "SHOULD_TRANSLATION_UI_APPEAR",
-    "SHUTDOWN_PHASE_DURATION_TICKS_PROFILE_BEFORE_CHANGE",
-    "SHUTDOWN_PHASE_DURATION_TICKS_PROFILE_CHANGE_TEARDOWN",
-    "SHUTDOWN_PHASE_DURATION_TICKS_QUIT_APPLICATION",
-    "SHUTDOWN_PHASE_DURATION_TICKS_XPCOM_WILL_SHUTDOWN",
     "SLOW_ADDON_WARNING_RESPONSE_TIME",
     "SLOW_ADDON_WARNING_STATES",
     "STARTUP_CRASH_DETECTED",
@@ -792,10 +788,6 @@
     "SERVICE_WORKER_WAS_SPAWNED",
     "SHOULD_AUTO_DETECT_LANGUAGE",
     "SHOULD_TRANSLATION_UI_APPEAR",
-    "SHUTDOWN_PHASE_DURATION_TICKS_PROFILE_BEFORE_CHANGE",
-    "SHUTDOWN_PHASE_DURATION_TICKS_PROFILE_CHANGE_TEARDOWN",
-    "SHUTDOWN_PHASE_DURATION_TICKS_QUIT_APPLICATION",
-    "SHUTDOWN_PHASE_DURATION_TICKS_XPCOM_WILL_SHUTDOWN",
     "SLOW_ADDON_WARNING_RESPONSE_TIME",
     "SLOW_ADDON_WARNING_STATES",
     "SLOW_SCRIPT_NOTICE_COUNT",

toolkit/components/terminator/TerminatorTelemetry.jsm

@@ -31,11 +31,16 @@ function nsTerminatorTelemetry() {}
 
 var HISTOGRAMS = {
   "quit-application": "SHUTDOWN_PHASE_DURATION_TICKS_QUIT_APPLICATION",
+  "profile-change-net-teardown":
+    "SHUTDOWN_PHASE_DURATION_TICKS_PROFILE_CHANGE_NET_TEARDOWN",
   "profile-change-teardown":
     "SHUTDOWN_PHASE_DURATION_TICKS_PROFILE_CHANGE_TEARDOWN",
   "profile-before-change":
     "SHUTDOWN_PHASE_DURATION_TICKS_PROFILE_BEFORE_CHANGE",
+  "profile-before-change-qm":
+    "SHUTDOWN_PHASE_DURATION_TICKS_PROFILE_BEFORE_CHANGE_QM",
   "xpcom-will-shutdown": "SHUTDOWN_PHASE_DURATION_TICKS_XPCOM_WILL_SHUTDOWN",
+  "xpcom-shutdown": "SHUTDOWN_PHASE_DURATION_TICKS_XPCOM_SHUTDOWN",
 };
 
 nsTerminatorTelemetry.prototype = {