blob: 0d67235294e22e6bf8824230351a25a261c7872f [file] [log] [blame]
// 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 <memory>
#include "base/files/file_path.h"
#include "base/gtest_prod_util.h"
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "base/task/task_scheduler/task_scheduler.h"
#include "base/timer/timer.h"
#include "build/build_config.h"
#include "content/browser/browser_process_sub_thread.h"
#include "content/public/browser/browser_main_runner.h"
#include "media/media_buildflags.h"
#include "mojo/public/cpp/bindings/binding_set.h"
#include "services/viz/public/interfaces/compositing/compositing_mode_watcher.mojom.h"
#include "ui/base/ui_features.h"
#if defined(OS_CHROMEOS)
#include "content/browser/media/keyboard_mic_registration.h"
#if defined(USE_AURA)
namespace aura {
class Env;
namespace base {
class CommandLine;
class FilePath;
class HighResolutionTimerManager;
class MemoryPressureMonitor;
class MessageLoop;
class PowerMonitor;
class SingleThreadTaskRunner;
class SystemMonitor;
namespace trace_event {
class TraceEventSystemStatsMonitor;
} // namespace trace_event
} // namespace base
namespace discardable_memory {
class DiscardableSharedMemoryManager;
namespace gpu {
class GpuChannelEstablishFactory;
namespace media {
class AudioManager;
class AudioSystem;
#if defined(OS_WIN)
class SystemMessageWindowWin;
#elif defined(OS_LINUX) && defined(USE_UDEV)
class DeviceMonitorLinux;
class UserInputMonitor;
#if defined(OS_MACOSX)
class DeviceMonitorMac;
} // namespace media
namespace midi {
class MidiService;
} // namespace midi
namespace mojo {
namespace core {
class ScopedIPCSupport;
} // namespace core
} // namespace mojo
namespace net {
class NetworkChangeNotifier;
} // namespace net
namespace viz {
class CompositingModeReporterImpl;
class FrameSinkManagerImpl;
class HostFrameSinkManager;
class ServerSharedBitmapManager;
namespace content {
class BrowserMainParts;
class BrowserOnlineStateObserver;
class BrowserThreadImpl;
class LoaderDelegateImpl;
class MediaStreamManager;
class ResourceDispatcherHostImpl;
class SaveFileManager;
class ScreenlockMonitor;
class ServiceManagerContext;
class SpeechRecognitionManagerImpl;
class StartupTaskRunner;
class SwapMetricsDriver;
class TracingControllerImpl;
struct MainFunctionParams;
namespace responsiveness {
class Watcher;
} // namespace responsiveness
#if defined(OS_ANDROID)
class ScreenOrientationDelegate;
#if defined(USE_X11)
namespace internal {
class GpuDataManagerVisualProxy;
// Implements the main browser loop stages called from BrowserMainRunner.
// See comments in browser_main_parts.h for additional info.
class CONTENT_EXPORT BrowserMainLoop {
// Returns the current instance. This is used to get access to the getters
// that return objects which are owned by this class.
static BrowserMainLoop* GetInstance();
static media::AudioManager* GetAudioManager();
// The TaskScheduler instance must exist but not to be started when building
// BrowserMainLoop.
explicit BrowserMainLoop(
const MainFunctionParams& parameters,
std::unique_ptr<base::TaskScheduler::ScopedExecutionFence> fence);
virtual ~BrowserMainLoop();
void Init();
// Return value is exit status. Anything other than RESULT_CODE_NORMAL_EXIT
// is considered an error.
int EarlyInitialization();
// Initializes the toolkit. Returns whether the toolkit initialization was
// successful or not.
bool InitializeToolkit();
void PreMainMessageLoopStart();
void MainMessageLoopStart();
void PostMainMessageLoopStart();
void PreShutdown();
// Create and start running the tasks we need to complete startup. Note that
// this can be called more than once (currently only on Android) if we get a
// request for synchronous startup while the tasks created by asynchronous
// startup are still running.
void CreateStartupTasks();
// Perform the default message loop run logic.
void RunMainMessageLoopParts();
// Performs the shutdown sequence, starting with PostMainMessageLoopRun
// through stopping threads to PostDestroyThreads.
void ShutdownThreadsAndCleanUp();
int GetResultCode() const { return result_code_; }
media::AudioManager* audio_manager() const;
bool AudioServiceOutOfProcess() const;
media::AudioSystem* audio_system() const { return audio_system_.get(); }
MediaStreamManager* media_stream_manager() const {
return media_stream_manager_.get();
media::UserInputMonitor* user_input_monitor() const {
return user_input_monitor_.get();
net::NetworkChangeNotifier* network_change_notifier() const {
return network_change_notifier_.get();
#if defined(OS_CHROMEOS)
KeyboardMicRegistration* keyboard_mic_registration() {
return &keyboard_mic_registration_;
discardable_shared_memory_manager() const {
return discardable_shared_memory_manager_.get();
midi::MidiService* midi_service() const { return midi_service_.get(); }
base::FilePath GetStartupTraceFileName() const;
const base::FilePath& startup_trace_file() const {
return startup_trace_file_;
// Returns the task runner for tasks that that are critical to producing a new
// CompositorFrame on resize. On Mac this will be the task runner provided by
// WindowResizeHelperMac, on other platforms it will just be the thread task
// runner.
scoped_refptr<base::SingleThreadTaskRunner> GetResizeTaskRunner();
gpu::GpuChannelEstablishFactory* gpu_channel_establish_factory() const;
#if defined(OS_ANDROID)
void SynchronouslyFlushStartupTasks();
#endif // OS_ANDROID
#if !defined(OS_ANDROID)
// TODO(fsamuel): We should find an object to own HostFrameSinkManager on all
// platforms including Android. See
viz::HostFrameSinkManager* host_frame_sink_manager() const {
return host_frame_sink_manager_.get();
// TODO( This will be removed once there are no users, as
// SurfaceManager is being moved out of process.
viz::FrameSinkManagerImpl* GetFrameSinkManager() const;
// This returns null when the display compositor is out of process.
viz::ServerSharedBitmapManager* GetServerSharedBitmapManager() const;
// Fulfills a mojo pointer to the singleton CompositingModeReporter.
void GetCompositingModeReporter(
viz::mojom::CompositingModeReporterRequest request);
void StopStartupTracingTimer();
#if defined(OS_MACOSX) && !defined(OS_IOS)
media::DeviceMonitorMac* device_monitor_mac() const {
return device_monitor_mac_.get();
BrowserMainParts* parts() { return parts_.get(); }
FRIEND_TEST_ALL_PREFIXES(BrowserMainLoopTest, CreateThreadsInSingleProcess);
void InitializeMainThread();
// Called just before creating the threads
int PreCreateThreads();
// Create all secondary threads.
int CreateThreads();
// Called just after creating the threads.
int PostCreateThreads();
// Called right after the browser threads have been started.
int BrowserThreadsStarted();
int PreMainMessageLoopRun();
void MainMessageLoopRun();
void InitializeMojo();
void InitStartupTracingForDuration();
void EndStartupTracing();
void InitializeAudio();
bool UsingInProcessGpu() const;
void InitializeMemoryManagementComponent();
// Quick reference for initialization order:
// Constructor
// Init()
// EarlyInitialization()
// InitializeToolkit()
// PreMainMessageLoopStart()
// MainMessageLoopStart()
// InitializeMainThread()
// PostMainMessageLoopStart()
// CreateStartupTasks()
// PreCreateThreads()
// CreateThreads()
// PostCreateThreads()
// BrowserThreadsStarted()
// InitializeMojo()
// InitStartupTracingForDuration()
// PreMainMessageLoopRun()
// Members initialized on construction ---------------------------------------
const MainFunctionParams& parameters_;
const base::CommandLine& parsed_command_line_;
int result_code_;
bool created_threads_; // True if the non-UI threads were created.
// //content must be initialized single-threaded until
// BrowserMainLoop::CreateThreads() as things initialized before it require an
// initialize-once happens-before relationship with all eventual content tasks
// running on other threads. This ScopedExecutionFence ensures that no tasks
// posted to TaskScheduler gets to run before CreateThreads(); satisfying this
// requirement even though the TaskScheduler is created and started before
// content is entered.
// Members initialized in |MainMessageLoopStart()| ---------------------------
std::unique_ptr<base::MessageLoop> main_message_loop_;
// Members initialized in |PostMainMessageLoopStart()| -----------------------
std::unique_ptr<BrowserProcessSubThread> io_thread_;
std::unique_ptr<base::SystemMonitor> system_monitor_;
std::unique_ptr<base::PowerMonitor> power_monitor_;
std::unique_ptr<base::HighResolutionTimerManager> hi_res_timer_manager_;
std::unique_ptr<net::NetworkChangeNotifier> network_change_notifier_;
std::unique_ptr<ScreenlockMonitor> screenlock_monitor_;
// Per-process listener for online state changes.
std::unique_ptr<BrowserOnlineStateObserver> online_state_observer_;
#if defined(USE_AURA)
std::unique_ptr<aura::Env> env_;
#if defined(OS_ANDROID)
// Android implementation of ScreenOrientationDelegate
std::unique_ptr<ScreenOrientationDelegate> screen_orientation_delegate_;
// Members initialized in |InitStartupTracingForDuration()| ------------------
base::FilePath startup_trace_file_;
// This timer initiates trace file saving.
base::OneShotTimer startup_trace_timer_;
// Members initialized in |Init()| -------------------------------------------
// Destroy |parts_| before |main_message_loop_| (required) and before other
// classes constructed in content (but after |main_thread_|).
std::unique_ptr<BrowserMainParts> parts_;
// Members initialized in |InitializeMainThread()| ---------------------------
// This must get destroyed before other threads that are created in |parts_|.
std::unique_ptr<BrowserThreadImpl> main_thread_;
// Members initialized in |CreateStartupTasks()| -----------------------------
std::unique_ptr<StartupTaskRunner> startup_task_runner_;
// Members initialized in |PreCreateThreads()| -------------------------------
// Torn down in ShutdownThreadsAndCleanUp.
std::unique_ptr<base::MemoryPressureMonitor> memory_pressure_monitor_;
std::unique_ptr<SwapMetricsDriver> swap_metrics_driver_;
#if defined(USE_X11)
ServiceManagerContext* service_manager_context_ = nullptr;
std::unique_ptr<ServiceManagerContext> owned_service_manager_context_;
// Members initialized in |BrowserThreadsStarted()| --------------------------
std::unique_ptr<mojo::core::ScopedIPCSupport> mojo_ipc_support_;
// |user_input_monitor_| has to outlive |audio_manager_|, so declared first.
std::unique_ptr<media::UserInputMonitor> user_input_monitor_;
// |audio_manager_| is not instantiated when the audio service runs out of
// process.
std::unique_ptr<media::AudioManager> audio_manager_;
std::unique_ptr<media::AudioSystem> audio_system_;
#if defined(OS_CHROMEOS)
KeyboardMicRegistration keyboard_mic_registration_;
std::unique_ptr<midi::MidiService> midi_service_;
// Must be deleted on the IO thread.
std::unique_ptr<SpeechRecognitionManagerImpl> speech_recognition_manager_;
#if defined(OS_WIN)
std::unique_ptr<media::SystemMessageWindowWin> system_message_window_;
#elif defined(OS_LINUX) && defined(USE_UDEV)
std::unique_ptr<media::DeviceMonitorLinux> device_monitor_linux_;
#elif defined(OS_MACOSX) && !defined(OS_IOS)
std::unique_ptr<media::DeviceMonitorMac> device_monitor_mac_;
std::unique_ptr<LoaderDelegateImpl> loader_delegate_;
std::unique_ptr<ResourceDispatcherHostImpl> resource_dispatcher_host_;
std::unique_ptr<MediaStreamManager> media_stream_manager_;
scoped_refptr<SaveFileManager> save_file_manager_;
std::unique_ptr<content::TracingControllerImpl> tracing_controller_;
scoped_refptr<responsiveness::Watcher> responsiveness_watcher_;
#if !defined(OS_ANDROID)
// A SharedBitmapManager used to sharing and mapping IDs to shared memory
// between processes for software compositing. When the display compositor is
// in the browser process, then |server_shared_bitmap_manager_| is set, and
// when it is in the viz process, then it is null.
std::unique_ptr<viz::ServerSharedBitmapManager> server_shared_bitmap_manager_;
std::unique_ptr<viz::HostFrameSinkManager> host_frame_sink_manager_;
// This is owned here so that SurfaceManager will be accessible in process
// when display is in the same process. Other than using SurfaceManager,
// access to |in_process_frame_sink_manager_| should happen via
// |host_frame_sink_manager_| instead which uses Mojo. See
std::unique_ptr<viz::FrameSinkManagerImpl> frame_sink_manager_impl_;
// Reports on the compositing mode in the system for clients to submit
// resources of the right type. This is null if the display compositor
// is not in this process.
// DO NOT add members here. Add them to the right categories above.
} // namespace content