[headless] Shutdown gracefully upon Ctrl-C, Ctrl-break, and console c…

…losure Migrate //headless to using //content's console control handler facilities. This reduces complexity in //headless and should slow the tide of crashes coming from child procs, where //headless was not previously installing a console control handler. Bug: 1473516 Change-Id: I320058d4806f3e80d82adefa72014ba727170629 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/4807610 Auto-Submit: Greg Thompson <[email protected]> Reviewed-by: Sami Kyöstilä <[email protected]> Reviewed-by: Rakina Zata Amni <[email protected]> Reviewed-by: Bruce Dawson <[email protected]> Reviewed-by: Peter Kvitek <[email protected]> Reviewed-by: Andrey Kosyakov <[email protected]> Commit-Queue: Rakina Zata Amni <[email protected]> Cr-Commit-Position: refs/heads/main@{#1188201}
MyoungJinNam · Aug 25, 2023 · 0c5b1f5 · 0c5b1f5
1 parent 28ae174
commit 0c5b1f5
Show file tree

Hide file tree

Showing 11 changed files with 31 additions and 96 deletions.
diff --git a/chrome/browser/chrome_content_browser_client.cc b/chrome/browser/chrome_content_browser_client.cc
@@ -4897,7 +4897,8 @@ bool ChromeContentBrowserClient::IsUtilityCetCompatible(
   return true;
 }
 
-void ChromeContentBrowserClient::SessionEnding() {
+void ChromeContentBrowserClient::SessionEnding(
+    absl::optional<DWORD> control_type) {
   chrome::SessionEnding();
 }
 

diff --git a/chrome/browser/chrome_content_browser_client.h b/chrome/browser/chrome_content_browser_client.h
@@ -494,7 +494,7 @@ class ChromeContentBrowserClient : public content::ContentBrowserClient {
   std::wstring GetLPACCapabilityNameForNetworkService() override;
   bool IsUtilityCetCompatible(const std::string& utility_sub_type) override;
   bool IsRendererCodeIntegrityEnabled() override;
-  void SessionEnding() override;
+  void SessionEnding(absl::optional<DWORD> control_type) override;
   bool ShouldEnableAudioProcessHighPriority() override;
 #endif
   void ExposeInterfacesToRenderer(

diff --git a/content/app/content_main_runner_impl.cc b/content/app/content_main_runner_impl.cc
@@ -463,7 +463,7 @@ mojo::ScopedMessagePipeHandle MaybeAcceptMojoInvitation() {
 
 #if BUILDFLAG(IS_WIN)
 void HandleConsoleControlEventOnBrowserUiThread(DWORD control_type) {
-  GetContentClient()->browser()->SessionEnding();
+  GetContentClient()->browser()->SessionEnding(control_type);
 }
 
 // A console control event handler for browser processes that initiates end

diff --git a/content/public/browser/content_browser_client.h b/content/public/browser/content_browser_client.h
@@ -1495,8 +1495,10 @@ class CONTENT_EXPORT ContentBrowserClient {
   // This is called on the UI thread.
   virtual bool IsRendererCodeIntegrityEnabled();
 
-  // Performs a fast and orderly shutdown of the browser.
-  virtual void SessionEnding() {}
+  // Performs a fast and orderly shutdown of the browser. If present,
+  // `control_type` is a CTRL_* value from a Windows console control handler;
+  // see https://learn.microsoft.com/en-us/windows/console/handlerroutine.
+  virtual void SessionEnding(absl::optional<DWORD> control_type) {}
 
   // Returns true if the audio process should run with high priority. false
   // otherwise.

diff --git a/headless/BUILD.gn b/headless/BUILD.gn
@@ -383,10 +383,6 @@ component("headless_non_renderer") {
     sources += [ "lib/browser/headless_browser_main_parts_posix.cc" ]
   }
 
-  if (is_win) {
-    sources += [ "lib/browser/headless_browser_main_parts_win.cc" ]
-  }
-
   if (use_aura) {
     sources += [
       "lib/browser/headless_browser_impl_aura.cc",

diff --git a/headless/lib/browser/headless_browser_main_parts.h b/headless/lib/browser/headless_browser_main_parts.h
@@ -48,7 +48,7 @@ class HEADLESS_EXPORT HeadlessBrowserMainParts
 #if BUILDFLAG(IS_MAC)
   void PreCreateMainMessageLoop() override;
 #endif
-#if BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_WIN)
+#if BUILDFLAG(IS_POSIX)
   void PostCreateMainMessageLoop() override;
 #endif
   void QuitMainMessageLoop();

diff --git a/headless/lib/browser/headless_browser_main_parts_win.cc b/headless/lib/browser/headless_browser_main_parts_win.cc
diff --git a/headless/lib/browser/headless_content_browser_client.cc b/headless/lib/browser/headless_content_browser_client.cc
@@ -348,6 +348,14 @@ HeadlessContentBrowserClient::GetGeolocationManager() {
 #endif
 }
 
+#if BUILDFLAG(IS_WIN)
+void HeadlessContentBrowserClient::SessionEnding(
+    absl::optional<DWORD> control_type) {
+  DCHECK_LT(control_type.value_or(0), 0x7fu);
+  browser_->ShutdownWithExitCode(control_type.value_or(0) + 0x80u);
+}
+#endif
+
 #if defined(HEADLESS_USE_POLICY)
 std::vector<std::unique_ptr<content::NavigationThrottle>>
 HeadlessContentBrowserClient::CreateThrottlesForNavigation(

diff --git a/headless/lib/browser/headless_content_browser_client.h b/headless/lib/browser/headless_content_browser_client.h
@@ -94,6 +94,9 @@ class HeadlessContentBrowserClient : public content::ContentBrowserClient {
 
   bool CanAcceptUntrustedExchangesIfNeeded() override;
   device::GeolocationManager* GetGeolocationManager() override;
+#if BUILDFLAG(IS_WIN)
+  void SessionEnding(absl::optional<DWORD> control_type) override;
+#endif
 
 #if defined(HEADLESS_USE_POLICY)
   std::vector<std::unique_ptr<content::NavigationThrottle>>

diff --git a/headless/lib/headless_content_main_delegate.cc b/headless/lib/headless_content_main_delegate.cc
@@ -464,6 +464,14 @@ absl::optional<int> HeadlessContentMainDelegate::PreBrowserMain() {
   return absl::nullopt;
 }
 
+#if BUILDFLAG(IS_WIN)
+bool HeadlessContentMainDelegate::ShouldHandleConsoleControlEvents() {
+  // Handle console control events so that orderly shutdown can be performed by
+  // HeadlessContentBrowserClient's override of SessionEnding.
+  return true;
+}
+#endif
+
 content::ContentClient* HeadlessContentMainDelegate::CreateContentClient() {
   return &content_client_;
 }

diff --git a/headless/lib/headless_content_main_delegate.h b/headless/lib/headless_content_main_delegate.h
@@ -46,6 +46,9 @@ class HEADLESS_EXPORT HeadlessContentMainDelegate
       const std::string& process_type,
       content::MainFunctionParams main_function_params) override;
   absl::optional<int> PreBrowserMain() override;
+#if BUILDFLAG(IS_WIN)
+  bool ShouldHandleConsoleControlEvents() override;
+#endif
   content::ContentClient* CreateContentClient() override;
   content::ContentBrowserClient* CreateContentBrowserClient() override;
   content::ContentUtilityClient* CreateContentUtilityClient() override;