content/browser/browser_main_loop.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CONTENT_BROWSER_BROWSER_MAIN_LOOP_H_
   6 #define CONTENT_BROWSER_BROWSER_MAIN_LOOP_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/files/file_path.h"
  10 #include "base/memory/ref_counted.h"
  11 #include "base/memory/scoped_ptr.h"
  12 #include "base/timer/timer.h"
  13 #include "content/browser/browser_process_sub_thread.h"
  14 #include "content/public/browser/browser_main_runner.h"
  15
  16 namespace base {
  17 class CommandLine;
  18 class FilePath;
  19 class HighResolutionTimerManager;
  20 class MessageLoop;
  21 class PowerMonitor;
  22 class SystemMonitor;
  23 class MemoryPressureMonitor;
  24 namespace trace_event {
  25 class TraceMemoryController;
  26 class TraceEventSystemStatsMonitor;
  27 }  // namespace trace_event
  28 }  // namespace base
  29
  30 namespace media {
  31 class AudioManager;
  32 class UserInputMonitor;
  33 namespace midi {
  34 class MidiManager;
  35 }  // namespace midi
  36 }  // namespace media
  37
  38 namespace net {
  39 class NetworkChangeNotifier;
  40 }  // namespace net
  41
  42 namespace content {
  43 class BrowserMainParts;
  44 class BrowserOnlineStateObserver;
  45 class BrowserShutdownImpl;
  46 class BrowserThreadImpl;
  47 class MediaStreamManager;
  48 class MojoShellContext;
  49 class ResourceDispatcherHostImpl;
  50 class SpeechRecognitionManagerImpl;
  51 class StartupTaskRunner;
  52 class TimeZoneMonitor;
  53 struct MainFunctionParams;
  54
  55 #if defined(OS_ANDROID)
  56 class ScreenOrientationDelegate;
  57 #elif defined(OS_LINUX)
  58 class DeviceMonitorLinux;
  59 #elif defined(OS_MACOSX)
  60 class DeviceMonitorMac;
  61 #elif defined(OS_WIN)
  62 class SystemMessageWindowWin;
  63 #endif
  64
  65 // Implements the main browser loop stages called from BrowserMainRunner.
  66 // See comments in browser_main_parts.h for additional info.
  67 class CONTENT_EXPORT BrowserMainLoop {
  68  public:
  69   // Returns the current instance. This is used to get access to the getters
  70   // that return objects which are owned by this class.
  71   static BrowserMainLoop* GetInstance();
  72
  73   explicit BrowserMainLoop(const MainFunctionParams& parameters);
  74   virtual ~BrowserMainLoop();
  75
  76   void Init();
  77
  78   void EarlyInitialization();
  79
  80   // Initializes the toolkit. Returns whether the toolkit initialization was
  81   // successful or not.
  82   bool InitializeToolkit();
  83
  84   void PreMainMessageLoopStart();
  85   void MainMessageLoopStart();
  86   void PostMainMessageLoopStart();
  87
  88   // Create and start running the tasks we need to complete startup. Note that
  89   // this can be called more than once (currently only on Android) if we get a
  90   // request for synchronous startup while the tasks created by asynchronous
  91   // startup are still running.
  92   void CreateStartupTasks();
  93
  94   // Perform the default message loop run logic.
  95   void RunMainMessageLoopParts();
  96
  97   // Performs the shutdown sequence, starting with PostMainMessageLoopRun
  98   // through stopping threads to PostDestroyThreads.
  99   void ShutdownThreadsAndCleanUp();
 100
 101   int GetResultCode() const { return result_code_; }
 102
 103   media::AudioManager* audio_manager() const { return audio_manager_.get(); }
 104   MediaStreamManager* media_stream_manager() const {
 105     return media_stream_manager_.get();
 106   }
 107   media::UserInputMonitor* user_input_monitor() const {
 108     return user_input_monitor_.get();
 109   }
 110   media::midi::MidiManager* midi_manager() const { return midi_manager_.get(); }
 111   base::Thread* indexed_db_thread() const { return indexed_db_thread_.get(); }
 112
 113   bool is_tracing_startup() const { return is_tracing_startup_; }
 114
 115   const base::FilePath& startup_trace_file() const {
 116     return startup_trace_file_;
 117   }
 118
 119   void StopStartupTracingTimer();
 120
 121 #if defined(OS_MACOSX) && !defined(OS_IOS)
 122   DeviceMonitorMac* device_monitor_mac() const {
 123     return device_monitor_mac_.get();
 124   }
 125 #endif
 126
 127  private:
 128   class MemoryObserver;
 129   // For ShutdownThreadsAndCleanUp.
 130   friend class BrowserShutdownImpl;
 131
 132   void InitializeMainThread();
 133
 134   // Called just before creating the threads
 135   int PreCreateThreads();
 136
 137   // Create all secondary threads.
 138   int CreateThreads();
 139
 140   // Called right after the browser threads have been started.
 141   int BrowserThreadsStarted();
 142
 143   int PreMainMessageLoopRun();
 144
 145   void MainMessageLoopRun();
 146
 147   base::FilePath GetStartupTraceFileName(
 148       const base::CommandLine& command_line) const;
 149   void InitStartupTracing(const base::CommandLine& command_line);
 150   void EndStartupTracing();
 151
 152   bool UsingInProcessGpu() const;
 153
 154   // Quick reference for initialization order:
 155   // Constructor
 156   // Init()
 157   // EarlyInitialization()
 158   // InitializeToolkit()
 159   // PreMainMessageLoopStart()
 160   // MainMessageLoopStart()
 161   //   InitializeMainThread()
 162   // PostMainMessageLoopStart()
 163   //   InitStartupTracing()
 164   // CreateStartupTasks()
 165   //   PreCreateThreads()
 166   //   CreateThreads()
 167   //   BrowserThreadsStarted()
 168
 169   // Members initialized on construction ---------------------------------------
 170   const MainFunctionParams& parameters_;
 171   const base::CommandLine& parsed_command_line_;
 172   int result_code_;
 173   bool created_threads_;  // True if the non-UI threads were created.
 174   bool is_tracing_startup_;
 175
 176   // Members initialized in |MainMessageLoopStart()| ---------------------------
 177   scoped_ptr<base::MessageLoop> main_message_loop_;
 178
 179   // Members initialized in |PostMainMessageLoopStart()| -----------------------
 180   scoped_ptr<base::SystemMonitor> system_monitor_;
 181   scoped_ptr<base::PowerMonitor> power_monitor_;
 182   scoped_ptr<base::HighResolutionTimerManager> hi_res_timer_manager_;
 183   scoped_ptr<net::NetworkChangeNotifier> network_change_notifier_;
 184
 185   // Per-process listener for online state changes.
 186   scoped_ptr<BrowserOnlineStateObserver> online_state_observer_;
 187
 188   scoped_ptr<base::trace_event::TraceEventSystemStatsMonitor>
 189       system_stats_monitor_;
 190
 191 #if defined(OS_WIN)
 192   scoped_ptr<SystemMessageWindowWin> system_message_window_;
 193 #endif
 194
 195 #if defined(OS_ANDROID)
 196   // Android implementation of ScreenOrientationDelegate
 197   scoped_ptr<ScreenOrientationDelegate> screen_orientation_delegate_;
 198 #endif
 199
 200   scoped_ptr<MemoryObserver> memory_observer_;
 201   scoped_ptr<base::trace_event::TraceMemoryController> trace_memory_controller_;
 202
 203   // Members initialized in |InitStartupTracing()| -----------------------------
 204   base::FilePath startup_trace_file_;
 205
 206   // This timer initiates trace file saving.
 207   base::OneShotTimer<BrowserMainLoop> startup_trace_timer_;
 208
 209   // Members initialized in |Init()| -------------------------------------------
 210   // Destroy |parts_| before |main_message_loop_| (required) and before other
 211   // classes constructed in content (but after |main_thread_|).
 212   scoped_ptr<BrowserMainParts> parts_;
 213
 214   // Members initialized in |InitializeMainThread()| ---------------------------
 215   // This must get destroyed before other threads that are created in |parts_|.
 216   scoped_ptr<BrowserThreadImpl> main_thread_;
 217
 218   // Members initialized in |CreateStartupTasks()| -----------------------------
 219   scoped_ptr<StartupTaskRunner> startup_task_runner_;
 220
 221   // Members initialized in |PreCreateThreads()| -------------------------------
 222   // Torn down in ShutdownThreadsAndCleanUp.
 223   scoped_ptr<base::MemoryPressureMonitor> memory_pressure_monitor_;
 224
 225   // Members initialized in |CreateThreads()| ----------------------------------
 226   scoped_ptr<BrowserProcessSubThread> db_thread_;
 227   scoped_ptr<BrowserProcessSubThread> file_user_blocking_thread_;
 228   scoped_ptr<BrowserProcessSubThread> file_thread_;
 229   scoped_ptr<BrowserProcessSubThread> process_launcher_thread_;
 230   scoped_ptr<BrowserProcessSubThread> cache_thread_;
 231   scoped_ptr<BrowserProcessSubThread> io_thread_;
 232
 233   // Members initialized in |BrowserThreadsStarted()| --------------------------
 234   scoped_ptr<base::Thread> indexed_db_thread_;
 235   scoped_ptr<MojoShellContext> mojo_shell_context_;
 236
 237   // |user_input_monitor_| has to outlive |audio_manager_|, so declared first.
 238   scoped_ptr<media::UserInputMonitor> user_input_monitor_;
 239   scoped_ptr<media::AudioManager> audio_manager_;
 240
 241   scoped_ptr<media::midi::MidiManager> midi_manager_;
 242
 243 #if defined(USE_UDEV)
 244   scoped_ptr<DeviceMonitorLinux> device_monitor_linux_;
 245 #elif defined(OS_MACOSX) && !defined(OS_IOS)
 246   scoped_ptr<DeviceMonitorMac> device_monitor_mac_;
 247 #endif
 248
 249   scoped_ptr<ResourceDispatcherHostImpl> resource_dispatcher_host_;
 250   scoped_ptr<MediaStreamManager> media_stream_manager_;
 251   scoped_ptr<SpeechRecognitionManagerImpl> speech_recognition_manager_;
 252   scoped_ptr<TimeZoneMonitor> time_zone_monitor_;
 253
 254   // DO NOT add members here. Add them to the right categories above.
 255
 256   DISALLOW_COPY_AND_ASSIGN(BrowserMainLoop);
 257 };
 258
 259 }  // namespace content
 260
 261 #endif  // CONTENT_BROWSER_BROWSER_MAIN_LOOP_H_