Add support for multithreading the GPU command buffer.

The CommandBufferProxyImpl has a lock which is held on receiving messages from the GPU and must be held by any code that executes GPU commands if it can be used from multiple threads.

Review URL: https://codereview.chromium.org/879403004

Cr-Commit-Position: refs/heads/master@{#315889}

content/common/gpu/client/command_buffer_proxy_impl.cc

@@ -27,7 +27,8 @@ namespace content {
 
 CommandBufferProxyImpl::CommandBufferProxyImpl(GpuChannelHost* channel,
                                                int route_id)
-    : channel_(channel),
+    : lock_(nullptr),
+      channel_(channel),
       route_id_(route_id),
       flush_count_(0),
       last_put_offset_(-1),
@@ -42,6 +43,9 @@ CommandBufferProxyImpl::~CommandBufferProxyImpl() {
 }
 
 bool CommandBufferProxyImpl::OnMessageReceived(const IPC::Message& message) {
+  scoped_ptr<base::AutoLock> lock;
+  if (lock_)
+    lock.reset(new base::AutoLock(*lock_));
   bool handled = true;
   IPC_BEGIN_MESSAGE_MAP(CommandBufferProxyImpl, message)
     IPC_MESSAGE_HANDLER(GpuCommandBufferMsg_Destroyed, OnDestroyed);
@@ -60,10 +64,14 @@ bool CommandBufferProxyImpl::OnMessageReceived(const IPC::Message& message) {
 }
 
 void CommandBufferProxyImpl::OnChannelError() {
+  scoped_ptr<base::AutoLock> lock;
+  if (lock_)
+    lock.reset(new base::AutoLock(*lock_));
   OnDestroyed(gpu::error::kUnknown);
 }
 
 void CommandBufferProxyImpl::OnDestroyed(gpu::error::ContextLostReason reason) {
+  CheckLock();
   // Prevent any further messages from being sent.
   channel_ = NULL;
 
@@ -88,6 +96,7 @@ void CommandBufferProxyImpl::OnConsoleMessage(
 
 void CommandBufferProxyImpl::SetMemoryAllocationChangedCallback(
     const MemoryAllocationChangedCallback& callback) {
+  CheckLock();
   if (last_state_.error != gpu::error::kNoError)
     return;
 
@@ -97,11 +106,13 @@ void CommandBufferProxyImpl::SetMemoryAllocationChangedCallback(
 }
 
 void CommandBufferProxyImpl::AddDeletionObserver(DeletionObserver* observer) {
+  CheckLock();
   deletion_observers_.AddObserver(observer);
 }
 
 void CommandBufferProxyImpl::RemoveDeletionObserver(
     DeletionObserver* observer) {
+  CheckLock();
   deletion_observers_.RemoveObserver(observer);
 }
 
@@ -121,6 +132,7 @@ void CommandBufferProxyImpl::OnSignalSyncPointAck(uint32 id) {
 
 void CommandBufferProxyImpl::SetChannelErrorCallback(
     const base::Closure& callback) {
+  CheckLock();
   channel_error_callback_ = callback;
 }
 
@@ -171,6 +183,7 @@ int32 CommandBufferProxyImpl::GetLastToken() {
 }
 
 void CommandBufferProxyImpl::Flush(int32 put_offset) {
+  CheckLock();
   if (last_state_.error != gpu::error::kNoError)
     return;
 
@@ -213,16 +226,19 @@ void CommandBufferProxyImpl::OrderingBarrier(int32 put_offset) {
 
 void CommandBufferProxyImpl::SetLatencyInfo(
     const std::vector<ui::LatencyInfo>& latency_info) {
+  CheckLock();
   for (size_t i = 0; i < latency_info.size(); i++)
     latency_info_.push_back(latency_info[i]);
 }
 
 void CommandBufferProxyImpl::SetSwapBuffersCompletionCallback(
     const SwapBuffersCompletionCallback& callback) {
+  CheckLock();
   swap_buffers_completion_callback_ = callback;
 }
 
 void CommandBufferProxyImpl::WaitForTokenInRange(int32 start, int32 end) {
+  CheckLock();
   TRACE_EVENT2("gpu",
                "CommandBufferProxyImpl::WaitForToken",
                "start",
@@ -242,6 +258,7 @@ void CommandBufferProxyImpl::WaitForTokenInRange(int32 start, int32 end) {
 }
 
 void CommandBufferProxyImpl::WaitForGetOffsetInRange(int32 start, int32 end) {
+  CheckLock();
   TRACE_EVENT2("gpu",
                "CommandBufferProxyImpl::WaitForGetOffset",
                "start",
@@ -261,6 +278,7 @@ void CommandBufferProxyImpl::WaitForGetOffsetInRange(int32 start, int32 end) {
 }
 
 void CommandBufferProxyImpl::SetGetBuffer(int32 shm_id) {
+  CheckLock();
   if (last_state_.error != gpu::error::kNoError)
     return;
 
@@ -271,6 +289,7 @@ void CommandBufferProxyImpl::SetGetBuffer(int32 shm_id) {
 scoped_refptr<gpu::Buffer> CommandBufferProxyImpl::CreateTransferBuffer(
     size_t size,
     int32* id) {
+  CheckLock();
   *id = -1;
 
   if (last_state_.error != gpu::error::kNoError)
@@ -309,6 +328,7 @@ scoped_refptr<gpu::Buffer> CommandBufferProxyImpl::CreateTransferBuffer(
 }
 
 void CommandBufferProxyImpl::DestroyTransferBuffer(int32 id) {
+  CheckLock();
   if (last_state_.error != gpu::error::kNoError)
     return;
 
@@ -323,6 +343,7 @@ int32_t CommandBufferProxyImpl::CreateImage(ClientBuffer buffer,
                                             size_t width,
                                             size_t height,
                                             unsigned internalformat) {
+  CheckLock();
   if (last_state_.error != gpu::error::kNoError)
     return -1;
 
@@ -362,6 +383,7 @@ int32_t CommandBufferProxyImpl::CreateImage(ClientBuffer buffer,
 }
 
 void CommandBufferProxyImpl::DestroyImage(int32 id) {
+  CheckLock();
   if (last_state_.error != gpu::error::kNoError)
     return;
 
@@ -373,6 +395,7 @@ int32_t CommandBufferProxyImpl::CreateGpuMemoryBufferImage(
     size_t height,
     unsigned internalformat,
     unsigned usage) {
+  CheckLock();
   scoped_ptr<gfx::GpuMemoryBuffer> buffer(
       channel_->gpu_memory_buffer_manager()->AllocateGpuMemoryBuffer(
           gfx::Size(width, height),
@@ -389,6 +412,7 @@ int CommandBufferProxyImpl::GetRouteID() const {
 }
 
 uint32 CommandBufferProxyImpl::CreateStreamTexture(uint32 texture_id) {
+  CheckLock();
   if (last_state_.error != gpu::error::kNoError)
     return 0;
 
@@ -403,7 +427,12 @@ uint32 CommandBufferProxyImpl::CreateStreamTexture(uint32 texture_id) {
   return stream_id;
 }
 
+void CommandBufferProxyImpl::SetLock(base::Lock* lock) {
+  lock_ = lock;
+}
+
 uint32 CommandBufferProxyImpl::InsertSyncPoint() {
+  CheckLock();
   if (last_state_.error != gpu::error::kNoError)
     return 0;
 
@@ -413,6 +442,7 @@ uint32 CommandBufferProxyImpl::InsertSyncPoint() {
 }
 
 uint32_t CommandBufferProxyImpl::InsertFutureSyncPoint() {
+  CheckLock();
   if (last_state_.error != gpu::error::kNoError)
     return 0;
 
@@ -422,6 +452,7 @@ uint32_t CommandBufferProxyImpl::InsertFutureSyncPoint() {
 }
 
 void CommandBufferProxyImpl::RetireSyncPoint(uint32_t sync_point) {
+  CheckLock();
   if (last_state_.error != gpu::error::kNoError)
     return;
 
@@ -430,6 +461,7 @@ void CommandBufferProxyImpl::RetireSyncPoint(uint32_t sync_point) {
 
 void CommandBufferProxyImpl::SignalSyncPoint(uint32 sync_point,
                                              const base::Closure& callback) {
+  CheckLock();
   if (last_state_.error != gpu::error::kNoError)
     return;
 
@@ -445,6 +477,7 @@ void CommandBufferProxyImpl::SignalSyncPoint(uint32 sync_point,
 
 void CommandBufferProxyImpl::SignalQuery(uint32 query,
                                          const base::Closure& callback) {
+  CheckLock();
   if (last_state_.error != gpu::error::kNoError)
     return;
 
@@ -467,13 +500,15 @@ void CommandBufferProxyImpl::SignalQuery(uint32 query,
 }
 
 void CommandBufferProxyImpl::SetSurfaceVisible(bool visible) {
+  CheckLock();
   if (last_state_.error != gpu::error::kNoError)
     return;
 
   Send(new GpuCommandBufferMsg_SetSurfaceVisible(route_id_, visible));
 }
 
 bool CommandBufferProxyImpl::ProduceFrontBuffer(const gpu::Mailbox& mailbox) {
+  CheckLock();
   if (last_state_.error != gpu::error::kNoError)
     return false;
 
@@ -533,6 +568,7 @@ void CommandBufferProxyImpl::OnUpdateState(
 
 void CommandBufferProxyImpl::SetOnConsoleMessageCallback(
     const GpuConsoleMessageCallback& callback) {
+  CheckLock();
   console_message_callback_ = callback;
 }
 

content/common/gpu/client/command_buffer_proxy_impl.h

@@ -116,6 +116,7 @@ class CommandBufferProxyImpl
   void SignalQuery(uint32 query, const base::Closure& callback) override;
   void SetSurfaceVisible(bool visible) override;
   uint32 CreateStreamTexture(uint32 texture_id) override;
+  void SetLock(base::Lock* lock) override;
 
   int GetRouteID() const;
   bool ProduceFrontBuffer(const gpu::Mailbox& mailbox);
@@ -157,6 +158,11 @@ class CommandBufferProxyImpl
   typedef base::ScopedPtrHashMap<int32, gfx::GpuMemoryBuffer>
       GpuMemoryBufferMap;
 
+  void CheckLock() {
+    if (lock_)
+      lock_->AssertAcquired();
+  }
+
   // Send an IPC message over the GPU channel. This is private to fully
   // encapsulate the channel; all callers of this function must explicitly
   // verify that the context has not been lost.
@@ -176,6 +182,8 @@ class CommandBufferProxyImpl
   // The shared memory area used to update state.
   gpu::CommandBufferSharedState* shared_state() const;
 
+  base::Lock* lock_;
+
   // Unowned list of DeletionObservers.
   ObserverList<DeletionObserver> deletion_observers_;
 

gpu/command_buffer/client/client_test_helper.h

@@ -110,6 +110,7 @@ class MockClientGpuControl : public GpuControl {
   MOCK_METHOD2(SignalQuery, void(uint32 query, const base::Closure& callback));
   MOCK_METHOD1(SetSurfaceVisible, void(bool visible));
   MOCK_METHOD1(CreateStreamTexture, uint32(uint32));
+  MOCK_METHOD1(SetLock, void(base::Lock*));
 
  private:
   DISALLOW_COPY_AND_ASSIGN(MockClientGpuControl);

gpu/command_buffer/client/gpu_control.h

@@ -17,6 +17,10 @@
 
 extern "C" typedef struct _ClientBuffer* ClientBuffer;
 
+namespace base {
+class Lock;
+}
+
 namespace gfx {
 class GpuMemoryBuffer;
 }
@@ -75,6 +79,12 @@ class GPU_EXPORT GpuControl {
   // returns a stream identifier.
   virtual uint32_t CreateStreamTexture(uint32_t texture_id) = 0;
 
+  // Sets a lock this will be held on every callback from the GPU
+  // implementation. This lock must be set and must be held on every call into
+  // the GPU implementation if it is to be used from multiple threads. This
+  // may not be supported with all implementations.
+  virtual void SetLock(base::Lock*) = 0;
+
  private:
   DISALLOW_COPY_AND_ASSIGN(GpuControl);
 };

gpu/command_buffer/service/in_process_command_buffer.cc

@@ -903,6 +903,10 @@ uint32 InProcessCommandBuffer::CreateStreamTexture(uint32 texture_id) {
   return stream_id;
 }
 
+void InProcessCommandBuffer::SetLock(base::Lock*) {
+  NOTIMPLEMENTED();
+}
+
 uint32 InProcessCommandBuffer::CreateStreamTextureOnGpuThread(
     uint32 client_texture_id) {
 #if defined(OS_ANDROID)

gpu/command_buffer/service/in_process_command_buffer.h

@@ -120,6 +120,7 @@ class GPU_EXPORT InProcessCommandBuffer : public CommandBuffer,
   void SignalQuery(uint32 query_id, const base::Closure& callback) override;
   void SetSurfaceVisible(bool visible) override;
   uint32 CreateStreamTexture(uint32 texture_id) override;
+  void SetLock(base::Lock*) override;
 
   // The serializer interface to the GPU service (i.e. thread).
   class Service {

gpu/command_buffer/tests/gl_manager.cc

@@ -429,4 +429,8 @@ uint32 GLManager::CreateStreamTexture(uint32 texture_id) {
   return 0;
 }
 
+void GLManager::SetLock(base::Lock*) {
+  NOTIMPLEMENTED();
+}
+
 }  // namespace gpu

gpu/command_buffer/tests/gl_manager.h

@@ -119,6 +119,7 @@ class GLManager : private GpuControl {
   void SignalQuery(uint32 query, const base::Closure& callback) override;
   void SetSurfaceVisible(bool visible) override;
   uint32 CreateStreamTexture(uint32 texture_id) override;
+  void SetLock(base::Lock*) override;
 
  private:
   void PumpCommands();

gpu/gles2_conform_support/egl/display.cc

@@ -335,4 +335,8 @@ uint32 Display::CreateStreamTexture(uint32 texture_id) {
   return 0;
 }
 
+void Display::SetLock(base::Lock*) {
+  NOTIMPLEMENTED();
+}
+
 }  // namespace egl

gpu/gles2_conform_support/egl/display.h

@@ -92,6 +92,7 @@ class Display : private gpu::GpuControl {
   void SignalQuery(uint32 query, const base::Closure& callback) override;
   void SetSurfaceVisible(bool visible) override;
   uint32 CreateStreamTexture(uint32 texture_id) override;
+  void SetLock(base::Lock*) override;
 
  private:
   EGLNativeDisplayType display_id_;

ppapi/proxy/ppapi_command_buffer_proxy.cc

@@ -156,6 +156,10 @@ uint32 PpapiCommandBufferProxy::CreateStreamTexture(uint32 texture_id) {
   return 0;
 }
 
+void PpapiCommandBufferProxy::SetLock(base::Lock*) {
+  NOTIMPLEMENTED();
+}
+
 uint32 PpapiCommandBufferProxy::InsertSyncPoint() {
   uint32 sync_point = 0;
   if (last_state_.error == gpu::error::kNoError) {

ppapi/proxy/ppapi_command_buffer_proxy.h

@@ -66,6 +66,7 @@ class PPAPI_PROXY_EXPORT PpapiCommandBufferProxy : public gpu::CommandBuffer,
                            const base::Closure& callback) override;
   virtual void SetSurfaceVisible(bool visible) override;
   virtual uint32 CreateStreamTexture(uint32 texture_id) override;
+  void SetLock(base::Lock*) override;
 
  private:
   bool Send(IPC::Message* msg);