Support sharing of ContentMain and BrowserMain code with embedded use cases.

content/app/content_main_runner.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#include "content/app/content_main.h"
+#include "content/public/app/content_main_runner.h"
 
 #include "base/at_exit.h"
 #include "base/command_line.h"
 #include "base/debug/debugger.h"
 #include "base/debug/trace_event.h"
 #include "base/i18n/icu_util.h"
 #include "base/logging.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/metrics/stats_table.h"
 #include "base/process_util.h"
 #include "base/stringprintf.h"
 #include "base/string_number_conversions.h"
 #include "content/browser/browser_main.h"
 #include "content/common/set_process_title.h"
 #include "content/public/app/content_main_delegate.h"
 #include "content/public/app/startup_helper_win.h"
 #include "content/public/common/content_client.h"
 #include "content/public/common/content_constants.h"
 #include "content/public/common/content_paths.h"
 #include "content/public/common/content_switches.h"
 #include "content/public/common/main_function_params.h"
 #include "content/public/common/sandbox_init.h"
 #include "crypto/nss_util.h"
 #include "ipc/ipc_switches.h"
+#include "sandbox/src/sandbox_types.h"
 #include "ui/base/ui_base_switches.h"
 #include "ui/base/ui_base_paths.h"
 #include "webkit/glue/webkit_glue.h"
 
 #if defined(OS_WIN)
 #include <atlbase.h>
 #include <atlapp.h>
 #include <malloc.h>
 #elif defined(OS_MACOSX)
 #include "base/mac/scoped_nsautorelease_pool.h"
 #include "base/mach_ipc_mac.h"
 #include "base/system_monitor/system_monitor.h"
 #include "content/browser/mach_broker_mac.h"
 #include "content/common/sandbox_init_mac.h"
-#endif // OS_WIN
+#endif  // OS_WIN
 
 #if defined(OS_POSIX)
 #include <signal.h>
 
 #include "base/global_descriptors_posix.h"
 #include "content/common/chrome_descriptors.h"
 
 #if !defined(OS_MACOSX)
 #include "content/public/common/zygote_fork_delegate_linux.h"
 #endif
@@ skipping 13 matching lines @@
 extern int RendererMain(const content::MainFunctionParams&);
 extern int WorkerMain(const content::MainFunctionParams&);
 extern int UtilityMain(const content::MainFunctionParams&);
 #if defined(OS_POSIX) && !defined(OS_MACOSX)
 extern int ZygoteMain(const content::MainFunctionParams&,
                       content::ZygoteForkDelegate* forkdelegate);
 #endif
 
 namespace {
 
-#if defined(OS_WIN)
-
-static CAppModule _Module;
-
-#elif defined(OS_MACOSX)
+#if defined(OS_MACOSX)
 
 // Completes the Mach IPC handshake by sending this process' task port to the
 // parent process.  The parent is listening on the Mach port given by
 // |GetMachPortName()|.  The task port is used by the parent to get CPU/memory
 // stats to display in the task manager.
 void SendTaskPortToParentProcess() {
   const mach_msg_timeout_t kTimeoutMs = 100;
   const int32_t kMessageId = 0;
   std::string mach_port_name = MachBroker::GetMachPortName();
 
@@ skipping 160 matching lines @@
     { switches::kRendererProcess,    RendererMain },
     { switches::kPluginProcess,      PluginMain },
     { switches::kWorkerProcess,      WorkerMain },
     { switches::kPpapiPluginProcess, PpapiPluginMain },
     { switches::kPpapiBrokerProcess, PpapiBrokerMain },
     { switches::kUtilityProcess,     UtilityMain },
     { switches::kGpuProcess,         GpuMain },
   };
 
   for (size_t i = 0; i < arraysize(kMainFunctions); ++i) {
-    if (process_type == kMainFunctions[i].name)
+    if (process_type == kMainFunctions[i].name) {
+      if (delegate) {
+        int exit_code = delegate->RunProcess(process_type,
+            main_function_params);
+        if (exit_code >= 0)
+          return exit_code;
+      }
       return kMainFunctions[i].function(main_function_params);
+    }
   }
 
 #if defined(OS_POSIX) && !defined(OS_MACOSX)
   // Zygote startup is special -- see RunZygote comments above
   // for why we don't use ZygoteMain directly.
   if (process_type == switches::kZygoteProcess)
     return RunZygote(main_function_params, delegate);
 #endif
 
   // If it's a process we don't know about, the embedder should know.
   if (delegate)
     return delegate->RunProcess(process_type, main_function_params);
 
   NOTREACHED() << "Unknown process type: " << process_type;
   return 1;
 }
 
+class ContentMainRunnerImpl : public content::ContentMainRunner {
+ public:
+  ContentMainRunnerImpl()
+      : is_initialized_(false),
+        is_shutdown_(false) {
+  }
+
+  ~ContentMainRunnerImpl() {
+    if (is_initialized_ && !is_shutdown_)
+      Shutdown();
+  }
+
+#if defined(OS_WIN)
+  virtual int Initialize(HINSTANCE instance,
+                         sandbox::SandboxInterfaceInfo* sandbox_info,
+                         content::ContentMainDelegate* delegate) OVERRIDE {
+    is_initialized_ = true;
+
+    // argc/argv are ignored on Windows; see command_line.h for details.
+    int argc = 0;
+    char** argv = NULL;
+
+    content::RegisterInvalidParamHandler();
+    app_module_.reset(new CAppModule);
+    app_module_->Init(NULL, static_cast<HINSTANCE>(instance));
+
+    if (sandbox_info)
+      sandbox_info_ = *sandbox_info;
+    else
+      memset(&sandbox_info_, 0, sizeof(sandbox_info_));
+
+#else   // !OS_WIN

[jam, 2012/02/01 17:28:39]

nit only two spaces before //

[Marshall, 2012/02/01 19:37:14]

Done.

+  virtual int Initialize(int argc,
+                         const char** argv,
+                         content::ContentMainDelegate* delegate) OVERRIDE {
+    is_initialized_ = true;

[jam, 2012/02/01 17:28:39]

nit: just move this common line (with 302) to 339

[Marshall, 2012/02/01 19:37:14]

Done.

+
+    // NOTE(willchan): One might ask why this call is done here rather than in
+    // process_util_linux.cc with the definition of
+    // EnableTerminationOnOutOfMemory().  That's because base shouldn't have a
+    // dependency on TCMalloc.  Really, we ought to have our allocator shim code
+    // implement this EnableTerminationOnOutOfMemory() function.  Whateverz.
+    // This works for now.
+#if !defined(OS_MACOSX) && defined(USE_TCMALLOC)
+    // For tcmalloc, we need to tell it to behave like new.
+    tc_set_new_mode(1);
+#endif
+
+#if !defined(OS_ANDROID)
+    // Set C library locale to make sure CommandLine can parse argument values
+    // in correct encoding.
+    setlocale(LC_ALL, "");
+#endif
+
+    SetupSignalHandlers();
+
+    base::GlobalDescriptors* g_fds = base::GlobalDescriptors::GetInstance();
+    g_fds->Set(kPrimaryIPCChannel,
+               kPrimaryIPCChannel + base::GlobalDescriptors::kBaseDescriptor);
+#if defined(OS_LINUX) || defined(OS_OPENBSD)
+    g_fds->Set(kCrashDumpSignal,
+               kCrashDumpSignal + base::GlobalDescriptors::kBaseDescriptor);
+#endif
+
+#endif  // !OS_WIN
+
+    delegate_ = delegate;
+
+    base::EnableTerminationOnHeapCorruption();
+    base::EnableTerminationOnOutOfMemory();
+
+    // The exit manager is in charge of calling the dtors of singleton objects.
+    exit_manager_.reset(new base::AtExitManager);
+
+#if defined(OS_MACOSX)
+    // We need this pool for all the objects created before we get to the
+    // event loop, but we don't want to leave them hanging around until the
+    // app quits. Each "main" needs to flush this pool right before it goes into
+    // its main event loop to get rid of the cruft.
+    autorelease_pool_.reset(new base::mac::ScopedNSAutoreleasePool());
+#endif
+
+    CommandLine::Init(argc, argv);
+
+    int exit_code;
+    if (delegate && delegate->BasicStartupComplete(&exit_code))
+      return exit_code;
+
+    const CommandLine& command_line = *CommandLine::ForCurrentProcess();
+    std::string process_type =
+          command_line.GetSwitchValueASCII(switches::kProcessType);
+
+    // Enable startup tracing asap to avoid early TRACE_EVENT calls being
+    // ignored.
+    if (command_line.HasSwitch(switches::kTraceStartup)) {
+      base::debug::TraceLog::GetInstance()->SetEnabled(
+          command_line.GetSwitchValueASCII(switches::kTraceStartup));
+    }
+
+#if defined(OS_MACOSX)
+    // We need to allocate the IO Ports before the Sandbox is initialized or
+    // the first instance of SystemMonitor is created.
+    // It's important not to allocate the ports for processes which don't
+    // register with the system monitor - see crbug.com/88867.
+    if (process_type.empty() ||
+        process_type == switches::kPluginProcess ||
+        process_type == switches::kRendererProcess ||
+        process_type == switches::kUtilityProcess ||
+        process_type == switches::kWorkerProcess ||
+        (delegate &&
+         delegate->ProcessRegistersWithSystemProcess(process_type))) {
+      base::SystemMonitor::AllocateSystemIOPorts();
+    }
+
+    if (!process_type.empty() &&
+        (!delegate || delegate->ShouldSendMachPort(process_type))) {
+      SendTaskPortToParentProcess();
+    }
+#elif defined(OS_WIN)
+    content::SetupCRT(command_line);
+#endif
+
+#if defined(OS_POSIX)
+    if (!process_type.empty()) {
+      // When you hit Ctrl-C in a terminal running the browser
+      // process, a SIGINT is delivered to the entire process group.
+      // When debugging the browser process via gdb, gdb catches the
+      // SIGINT for the browser process (and dumps you back to the gdb
+      // console) but doesn't for the child processes, killing them.
+      // The fix is to have child processes ignore SIGINT; they'll die
+      // on their own when the browser process goes away.
+      //
+      // Note that we *can't* rely on BeingDebugged to catch this case because
+      // we are the child process, which is not being debugged.
+      // TODO(evanm): move this to some shared subprocess-init function.
+      if (!base::debug::BeingDebugged())
+        signal(SIGINT, SIG_IGN);
+    }
+#endif
+
+#if defined(USE_NSS)
+    crypto::EarlySetupForNSSInit();
+#endif
+
+    ui::RegisterPathProvider();
+    content::RegisterPathProvider();
+
+    CHECK(icu_util::Initialize());
+
+    base::ProcessId browser_pid = base::GetCurrentProcId();
+    if (command_line.HasSwitch(switches::kProcessChannelID)) {
+#if defined(OS_WIN) || defined(OS_MACOSX)
+      std::string channel_name =
+          command_line.GetSwitchValueASCII(switches::kProcessChannelID);
+
+      int browser_pid_int;
+      base::StringToInt(channel_name, &browser_pid_int);
+      browser_pid = static_cast<base::ProcessId>(browser_pid_int);
+      DCHECK_NE(browser_pid_int, 0);
+#elif defined(OS_POSIX)
+      // On linux, we're in the zygote here; so we need the parent process' id.
+      browser_pid = base::GetParentProcessId(base::GetCurrentProcId());
+#endif
+    }
+
+    InitializeStatsTable(browser_pid, command_line);
+
+    if (delegate)
+      delegate->PreSandboxStartup();
+
+    if (!process_type.empty())
+      CommonSubprocessInit(process_type);
+
+#if defined(OS_WIN)
+    CHECK(content::InitializeSandbox(sandbox_info));
+#elif defined(OS_MACOSX)
+    if (process_type == switches::kRendererProcess ||
+        process_type == switches::kPpapiPluginProcess ||
+        (delegate && delegate->DelaySandboxInitialization(process_type))) {
+      // On OS X the renderer sandbox needs to be initialized later in the
+      // startup sequence in RendererMainPlatformDelegate::EnableSandbox().
+    } else {
+      CHECK(content::InitializeSandbox());
+    }
+#endif
+
+    if (delegate)
+      delegate->SandboxInitialized(process_type);
+
+#if defined(OS_POSIX)
+    SetProcessTitleFromCommandLine(argv);
+#endif
+
+    // Return -1 to indicate no early termination.
+    return -1;
+  }
+
+  virtual int Run() OVERRIDE {
+    DCHECK(is_initialized_);
+    DCHECK(!is_shutdown_);
+    const CommandLine& command_line = *CommandLine::ForCurrentProcess();
+    std::string process_type =
+          command_line.GetSwitchValueASCII(switches::kProcessType);
+
+    content::MainFunctionParams main_params(command_line);
+#if defined(OS_WIN)
+    main_params.sandbox_info = &sandbox_info_;
+#elif defined(OS_MACOSX)
+    main_params.autorelease_pool = autorelease_pool_.get();
+#endif
+
+    return RunNamedProcessTypeMain(process_type, main_params, delegate_);
+  }
+
+  virtual void Shutdown() OVERRIDE {
+    DCHECK(is_initialized_);
+    DCHECK(!is_shutdown_);
+    const CommandLine& command_line = *CommandLine::ForCurrentProcess();
+    std::string process_type =
+          command_line.GetSwitchValueASCII(switches::kProcessType);
+
+    if (delegate_)
+      delegate_->ProcessExiting(process_type);
+
+#if defined(OS_WIN)
+#ifdef _CRTDBG_MAP_ALLOC
+    _CrtDumpMemoryLeaks();
+#endif  // _CRTDBG_MAP_ALLOC
+
+    app_module_->Term();
+#endif  // OS_WIN
+
+#if defined(OS_MACOSX)
+    autorelease_pool_.reset(NULL);
+#endif
+
+    exit_manager_.reset(NULL);
+
+#if defined(OS_WIN)
+    app_module_.reset(NULL);
+#endif
+
+    delegate_ = NULL;
+    is_shutdown_ = true;
+  }
+
+ protected:
+  // True if the runner has been initialized.
+  bool is_initialized_;
+
+  // True if the runner has been shut down.
+  bool is_shutdown_;
+
+  // The delegate will outlive this object.
+  content::ContentMainDelegate* delegate_;
+
+  scoped_ptr<base::AtExitManager> exit_manager_;
+#if defined(OS_WIN)
+  sandbox::SandboxInterfaceInfo sandbox_info_;
+  scoped_ptr<CAppModule> app_module_;
+#elif defined(OS_MACOSX)
+  scoped_ptr<base::mac::ScopedNSAutoreleasePool> autorelease_pool_;
+#endif
+
+  DISALLOW_COPY_AND_ASSIGN(ContentMainRunnerImpl);
+};
+
 }  // namespace
 
 namespace content {
 
-#if defined(OS_WIN)
-int ContentMain(HINSTANCE instance,
-                sandbox::SandboxInterfaceInfo* sandbox_info,
-                ContentMainDelegate* delegate) {
-  // argc/argv are ignored on Windows; see command_line.h for details.
-  int argc = 0;
-  char** argv = NULL;
-
-  content::RegisterInvalidParamHandler();
-  _Module.Init(NULL, static_cast<HINSTANCE>(instance));
-#else
-int ContentMain(int argc,
-                const char** argv,
-                ContentMainDelegate* delegate) {
-  // NOTE(willchan): One might ask why this call is done here rather than in
-  // process_util_linux.cc with the definition of
-  // EnableTerminationOnOutOfMemory().  That's because base shouldn't have a
-  // dependency on TCMalloc.  Really, we ought to have our allocator shim code
-  // implement this EnableTerminationOnOutOfMemory() function.  Whateverz.  This
-  // works for now.
-#if !defined(OS_MACOSX) && defined(USE_TCMALLOC)
-  // For tcmalloc, we need to tell it to behave like new.
-  tc_set_new_mode(1);
-#endif
-
-#if !defined(OS_ANDROID)
-  // Set C library locale to make sure CommandLine can parse argument values
-  // in correct encoding.
-  setlocale(LC_ALL, "");
-#endif
-
-  SetupSignalHandlers();
-
-  base::GlobalDescriptors* g_fds = base::GlobalDescriptors::GetInstance();
-  g_fds->Set(kPrimaryIPCChannel,
-             kPrimaryIPCChannel + base::GlobalDescriptors::kBaseDescriptor);
-#if defined(OS_LINUX) || defined(OS_OPENBSD)
-  g_fds->Set(kCrashDumpSignal,
-             kCrashDumpSignal + base::GlobalDescriptors::kBaseDescriptor);
-#endif
-
-#endif  // OS_WIN
-
-  base::EnableTerminationOnHeapCorruption();
-  base::EnableTerminationOnOutOfMemory();
-
-  // The exit manager is in charge of calling the dtors of singleton objects.
-  base::AtExitManager exit_manager;
-
-#if defined(OS_MACOSX)
-  // We need this pool for all the objects created before we get to the
-  // event loop, but we don't want to leave them hanging around until the
-  // app quits. Each "main" needs to flush this pool right before it goes into
-  // its main event loop to get rid of the cruft.
-  base::mac::ScopedNSAutoreleasePool autorelease_pool;
-#endif
-
-  CommandLine::Init(argc, argv);
-
-  int exit_code;
-  if (delegate && delegate->BasicStartupComplete(&exit_code))
-    return exit_code;
-
-  const CommandLine& command_line = *CommandLine::ForCurrentProcess();
-  std::string process_type =
-        command_line.GetSwitchValueASCII(switches::kProcessType);
-
-  // Enable startup tracing asap to avoid early TRACE_EVENT calls being ignored.
-  if (command_line.HasSwitch(switches::kTraceStartup)) {
-    base::debug::TraceLog::GetInstance()->SetEnabled(
-        command_line.GetSwitchValueASCII(switches::kTraceStartup));
-  }
-
-#if defined(OS_MACOSX)
-  // We need to allocate the IO Ports before the Sandbox is initialized or
-  // the first instance of SystemMonitor is created.
-  // It's important not to allocate the ports for processes which don't register
-  // with the system monitor - see crbug.com/88867.
-  if (process_type.empty() ||
-      process_type == switches::kPluginProcess ||
-      process_type == switches::kRendererProcess ||
-      process_type == switches::kUtilityProcess ||
-      process_type == switches::kWorkerProcess ||
-      (delegate && delegate->ProcessRegistersWithSystemProcess(process_type))) {
-    base::SystemMonitor::AllocateSystemIOPorts();
-  }
-
-  if (!process_type.empty() &&
-      (!delegate || delegate->ShouldSendMachPort(process_type))) {
-    SendTaskPortToParentProcess();
-  }
-#elif defined(OS_WIN)
-  content::SetupCRT(command_line);
-#endif
-
-#if defined(OS_POSIX)
-  if (!process_type.empty()) {
-    // When you hit Ctrl-C in a terminal running the browser
-    // process, a SIGINT is delivered to the entire process group.
-    // When debugging the browser process via gdb, gdb catches the
-    // SIGINT for the browser process (and dumps you back to the gdb
-    // console) but doesn't for the child processes, killing them.
-    // The fix is to have child processes ignore SIGINT; they'll die
-    // on their own when the browser process goes away.
-    //
-    // Note that we *can't* rely on BeingDebugged to catch this case because we
-    // are the child process, which is not being debugged.
-    // TODO(evanm): move this to some shared subprocess-init function.
-    if (!base::debug::BeingDebugged())
-      signal(SIGINT, SIG_IGN);
-  }
-#endif
-
-#if defined(USE_NSS)
-  crypto::EarlySetupForNSSInit();
-#endif
-
-  ui::RegisterPathProvider();
-  content::RegisterPathProvider();
-
-  CHECK(icu_util::Initialize());
-
-  base::ProcessId browser_pid = base::GetCurrentProcId();
-  if (command_line.HasSwitch(switches::kProcessChannelID)) {
-#if defined(OS_WIN) || defined(OS_MACOSX)
-    std::string channel_name =
-        command_line.GetSwitchValueASCII(switches::kProcessChannelID);
-
-    int browser_pid_int;
-    base::StringToInt(channel_name, &browser_pid_int);
-    browser_pid = static_cast<base::ProcessId>(browser_pid_int);
-    DCHECK_NE(browser_pid_int, 0);
-#elif defined(OS_POSIX)
-    // On linux, we're in the zygote here; so we need the parent process' id.
-    browser_pid = base::GetParentProcessId(base::GetCurrentProcId());
-#endif
-  }
-
-  InitializeStatsTable(browser_pid, command_line);
-
-  if (delegate) delegate->PreSandboxStartup();
-
-  if (!process_type.empty())
-    CommonSubprocessInit(process_type);
-
-#if defined(OS_WIN)
-  CHECK(content::InitializeSandbox(sandbox_info));
-#elif defined(OS_MACOSX)
-  if (process_type == switches::kRendererProcess ||
-      process_type == switches::kPpapiPluginProcess ||
-      (delegate && delegate->DelaySandboxInitialization(process_type))) {
-    // On OS X the renderer sandbox needs to be initialized later in the startup
-    // sequence in RendererMainPlatformDelegate::EnableSandbox().
-  } else {
-    CHECK(content::InitializeSandbox());
-  }
-#endif
-
-  if (delegate) delegate->SandboxInitialized(process_type);
-
-#if defined(OS_POSIX)
-  SetProcessTitleFromCommandLine(argv);
-#endif
-
-  content::MainFunctionParams main_params(command_line);
-#if defined(OS_WIN)
-  main_params.sandbox_info = sandbox_info;
-#elif defined(OS_MACOSX)
-  main_params.autorelease_pool = &autorelease_pool;
-#endif
-
-  exit_code = RunNamedProcessTypeMain(process_type, main_params, delegate);
-
-  if (delegate) delegate->ProcessExiting(process_type);
-
-#if defined(OS_WIN)
-#ifdef _CRTDBG_MAP_ALLOC
-  _CrtDumpMemoryLeaks();
-#endif  // _CRTDBG_MAP_ALLOC
-
-  _Module.Term();
-#endif  // OS_WIN
-
-  return exit_code;
+// static
+ContentMainRunner* ContentMainRunner::Create() {
+  return new ContentMainRunnerImpl();
 }
 
 }  // namespace content