content/browser/gpu/gpu_process_host.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_GPU_GPU_PROCESS_HOST_H_
   6 #define CONTENT_BROWSER_GPU_GPU_PROCESS_HOST_H_
   7
   8 #include <map>
   9 #include <queue>
  10 #include <set>
  11 #include <string>
  12
  13 #include "base/callback.h"
  14 #include "base/containers/hash_tables.h"
  15 #include "base/memory/weak_ptr.h"
  16 #include "base/threading/non_thread_safe.h"
  17 #include "base/time/time.h"
  18 #include "content/browser/gpu/gpu_surface_tracker.h"
  19 #include "content/common/content_export.h"
  20 #include "content/common/gpu/gpu_memory_uma_stats.h"
  21 #include "content/common/gpu/gpu_process_launch_causes.h"
  22 #include "content/common/gpu/gpu_result_codes.h"
  23 #include "content/public/browser/browser_child_process_host_delegate.h"
  24 #include "content/public/browser/gpu_data_manager.h"
  25 #include "gpu/command_buffer/common/constants.h"
  26 #include "gpu/config/gpu_info.h"
  27 #include "ipc/ipc_sender.h"
  28 #include "ipc/message_filter.h"
  29 #include "ui/gfx/geometry/size.h"
  30 #include "ui/gfx/gpu_memory_buffer.h"
  31 #include "ui/gfx/native_widget_types.h"
  32 #include "url/gurl.h"
  33
  34 #if defined(OS_MACOSX) && !defined(OS_IOS)
  35 #include "content/common/mac/io_surface_manager_token.h"
  36 #endif
  37
  38 struct GPUCreateCommandBufferConfig;
  39
  40 namespace IPC {
  41 struct ChannelHandle;
  42 }
  43
  44 namespace content {
  45 class BrowserChildProcessHostImpl;
  46 class GpuMainThread;
  47 class InProcessChildThreadParams;
  48 class RenderWidgetHostViewFrameSubscriber;
  49 class ShaderDiskCache;
  50
  51 typedef base::Thread* (*GpuMainThreadFactoryFunction)(
  52     const InProcessChildThreadParams&);
  53
  54 class GpuProcessHost : public BrowserChildProcessHostDelegate,
  55                        public IPC::Sender,
  56                        public base::NonThreadSafe {
  57  public:
  58   enum GpuProcessKind {
  59     GPU_PROCESS_KIND_UNSANDBOXED,
  60     GPU_PROCESS_KIND_SANDBOXED,
  61     GPU_PROCESS_KIND_COUNT
  62   };
  63
  64   typedef base::Callback<void(const IPC::ChannelHandle&, const gpu::GPUInfo&)>
  65       EstablishChannelCallback;
  66
  67   typedef base::Callback<void(CreateCommandBufferResult)>
  68       CreateCommandBufferCallback;
  69
  70   typedef base::Callback<void(const gfx::GpuMemoryBufferHandle& handle)>
  71       CreateGpuMemoryBufferCallback;
  72
  73   static bool gpu_enabled() { return gpu_enabled_; }
  74   static int gpu_crash_count() { return gpu_crash_count_; }
  75
  76   // Creates a new GpuProcessHost or gets an existing one, resulting in the
  77   // launching of a GPU process if required.  Returns null on failure. It
  78   // is not safe to store the pointer once control has returned to the message
  79   // loop as it can be destroyed. Instead store the associated GPU host ID.
  80   // This could return NULL if GPU access is not allowed (blacklisted).
  81   CONTENT_EXPORT static GpuProcessHost* Get(GpuProcessKind kind,
  82                                             CauseForGpuLaunch cause);
  83
  84   // Retrieves a list of process handles for all gpu processes.
  85   static void GetProcessHandles(
  86       const GpuDataManager::GetGpuProcessHandlesCallback& callback);
  87
  88   // Helper function to send the given message to the GPU process on the IO
  89   // thread.  Calls Get and if a host is returned, sends it.  Can be called from
  90   // any thread.  Deletes the message if it cannot be sent.
  91   CONTENT_EXPORT static void SendOnIO(GpuProcessKind kind,
  92                                       CauseForGpuLaunch cause,
  93                                       IPC::Message* message);
  94
  95   CONTENT_EXPORT static void RegisterGpuMainThreadFactory(
  96       GpuMainThreadFactoryFunction create);
  97
  98   // Get the GPU process host for the GPU process with the given ID. Returns
  99   // null if the process no longer exists.
 100   static GpuProcessHost* FromID(int host_id);
 101   int host_id() const { return host_id_; }
 102
 103   // IPC::Sender implementation.
 104   bool Send(IPC::Message* msg) override;
 105
 106   // Adds a message filter to the GpuProcessHost's channel.
 107   void AddFilter(IPC::MessageFilter* filter);
 108
 109   // Tells the GPU process to create a new channel for communication with a
 110   // client. Once the GPU process responds asynchronously with the IPC handle
 111   // and GPUInfo, we call the callback.
 112   void EstablishGpuChannel(int client_id,
 113                            uint64_t client_tracing_id,
 114                            bool share_context,
 115                            bool allow_future_sync_points,
 116                            bool allow_real_time_streams,
 117                            const EstablishChannelCallback& callback);
 118
 119   // Tells the GPU process to create a new command buffer that draws into the
 120   // given surface.
 121   void CreateViewCommandBuffer(
 122       const gfx::GLSurfaceHandle& compositing_surface,
 123       int surface_id,
 124       int client_id,
 125       const GPUCreateCommandBufferConfig& init_params,
 126       int route_id,
 127       const CreateCommandBufferCallback& callback);
 128
 129   // Tells the GPU process to create a new GPU memory buffer.
 130   void CreateGpuMemoryBuffer(gfx::GpuMemoryBufferId id,
 131                              const gfx::Size& size,
 132                              gfx::BufferFormat format,
 133                              gfx::BufferUsage usage,
 134                              int client_id,
 135                              int32 surface_id,
 136                              const CreateGpuMemoryBufferCallback& callback);
 137
 138   // Tells the GPU process to destroy GPU memory buffer.
 139   void DestroyGpuMemoryBuffer(gfx::GpuMemoryBufferId id,
 140                               int client_id,
 141                               int sync_point);
 142
 143   // What kind of GPU process, e.g. sandboxed or unsandboxed.
 144   GpuProcessKind kind();
 145
 146   // Forcefully terminates the GPU process.
 147   void ForceShutdown();
 148
 149   // Asks the GPU process to stop by itself.
 150   void StopGpuProcess();
 151
 152   void BeginFrameSubscription(
 153       int surface_id,
 154       base::WeakPtr<RenderWidgetHostViewFrameSubscriber> subscriber);
 155   void EndFrameSubscription(int surface_id);
 156   void LoadedShader(const std::string& key, const std::string& data);
 157
 158  private:
 159   static bool ValidateHost(GpuProcessHost* host);
 160
 161   GpuProcessHost(int host_id, GpuProcessKind kind);
 162   ~GpuProcessHost() override;
 163
 164   bool Init();
 165
 166   // Post an IPC message to the UI shim's message handler on the UI thread.
 167   void RouteOnUIThread(const IPC::Message& message);
 168
 169   // BrowserChildProcessHostDelegate implementation.
 170   bool OnMessageReceived(const IPC::Message& message) override;
 171   void OnChannelConnected(int32 peer_pid) override;
 172   void OnProcessLaunched() override;
 173   void OnProcessLaunchFailed() override;
 174   void OnProcessCrashed(int exit_code) override;
 175
 176   // Message handlers.
 177   void OnInitialized(bool result, const gpu::GPUInfo& gpu_info);
 178   void OnChannelEstablished(const IPC::ChannelHandle& channel_handle);
 179   void OnCommandBufferCreated(CreateCommandBufferResult result);
 180   void OnDestroyCommandBuffer(int32 surface_id);
 181   void OnGpuMemoryBufferCreated(const gfx::GpuMemoryBufferHandle& handle);
 182   void OnDidCreateOffscreenContext(const GURL& url);
 183   void OnDidLoseContext(bool offscreen,
 184                         gpu::error::ContextLostReason reason,
 185                         const GURL& url);
 186   void OnDidDestroyOffscreenContext(const GURL& url);
 187   void OnGpuMemoryUmaStatsReceived(const GPUMemoryUmaStats& stats);
 188 #if defined(OS_MACOSX)
 189   void OnAcceleratedSurfaceBuffersSwapped(const IPC::Message& message);
 190 #endif
 191
 192   void CreateChannelCache(int32 client_id);
 193   void OnDestroyChannel(int32 client_id);
 194   void OnCacheShader(int32 client_id, const std::string& key,
 195                      const std::string& shader);
 196
 197   bool LaunchGpuProcess(const std::string& channel_id);
 198
 199   void SendOutstandingReplies();
 200
 201   void BlockLiveOffscreenContexts();
 202
 203   // Update GPU crash counters.  Disable GPU if crash limit is reached.
 204   void RecordProcessCrash();
 205
 206   std::string GetShaderPrefixKey();
 207
 208   // The serial number of the GpuProcessHost / GpuProcessHostUIShim pair.
 209   int host_id_;
 210
 211   // These are the channel requests that we have already sent to
 212   // the GPU process, but haven't heard back about yet.
 213   std::queue<EstablishChannelCallback> channel_requests_;
 214
 215   // The pending create command buffer requests we need to reply to.
 216   std::queue<CreateCommandBufferCallback> create_command_buffer_requests_;
 217
 218   // The pending create gpu memory buffer requests we need to reply to.
 219   std::queue<CreateGpuMemoryBufferCallback> create_gpu_memory_buffer_requests_;
 220
 221   // Surface ids for pending gpu memory buffer request refs.
 222   std::queue<int32> create_gpu_memory_buffer_surface_refs_;
 223
 224   // Qeueud messages to send when the process launches.
 225   std::queue<IPC::Message*> queued_messages_;
 226
 227   // Whether the GPU process is valid, set to false after Send() failed.
 228   bool valid_;
 229
 230   // Whether we are running a GPU thread inside the browser process instead
 231   // of a separate GPU process.
 232   bool in_process_;
 233
 234   bool swiftshader_rendering_;
 235   GpuProcessKind kind_;
 236
 237   scoped_ptr<base::Thread> in_process_gpu_thread_;
 238
 239   // Whether we actually launched a GPU process.
 240   bool process_launched_;
 241
 242   // Whether the GPU process successfully initialized.
 243   bool initialized_;
 244
 245   // Time Init started.  Used to log total GPU process startup time to UMA.
 246   base::TimeTicks init_start_time_;
 247
 248   // Master switch for enabling/disabling GPU acceleration for the current
 249   // browser session. It does not change the acceleration settings for
 250   // existing tabs, just the future ones.
 251   static bool gpu_enabled_;
 252
 253   static bool hardware_gpu_enabled_;
 254
 255   static int gpu_crash_count_;
 256   static int gpu_recent_crash_count_;
 257   static bool crashed_before_;
 258   static int swiftshader_crash_count_;
 259
 260   scoped_ptr<BrowserChildProcessHostImpl> process_;
 261
 262   // Track the URLs of the pages which have live offscreen contexts,
 263   // assumed to be associated with untrusted content such as WebGL.
 264   // For best robustness, when any context lost notification is
 265   // received, assume all of these URLs are guilty, and block
 266   // automatic execution of 3D content from those domains.
 267   std::multiset<GURL> urls_with_live_offscreen_contexts_;
 268
 269   // Statics kept around to send to UMA histograms on GPU process lost.
 270   bool uma_memory_stats_received_;
 271   GPUMemoryUmaStats uma_memory_stats_;
 272
 273   typedef std::map<int32, scoped_refptr<ShaderDiskCache> >
 274       ClientIdToShaderCacheMap;
 275   ClientIdToShaderCacheMap client_id_to_shader_cache_;
 276
 277   std::string shader_prefix_key_;
 278
 279   // Keep an extra reference to the SurfaceRef stored in the GpuSurfaceTracker
 280   // in this map so that we don't destroy it whilst the GPU process is
 281   // drawing to it.
 282   typedef std::multimap<int, scoped_refptr<GpuSurfaceTracker::SurfaceRef> >
 283       SurfaceRefMap;
 284   SurfaceRefMap surface_refs_;
 285
 286 #if defined(OS_MACOSX) && !defined(OS_IOS)
 287   // Unique unguessable token that the GPU process is using to register
 288   // IOSurfaces.
 289   IOSurfaceManagerToken io_surface_manager_token_;
 290 #endif
 291
 292   DISALLOW_COPY_AND_ASSIGN(GpuProcessHost);
 293 };
 294
 295 }  // namespace content
 296
 297 #endif  // CONTENT_BROWSER_GPU_GPU_PROCESS_HOST_H_