gpu/command_buffer/service/command_buffer_service.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 GPU_COMMAND_BUFFER_SERVICE_COMMAND_BUFFER_SERVICE_H_
   6 #define GPU_COMMAND_BUFFER_SERVICE_COMMAND_BUFFER_SERVICE_H_
   7
   8 #include "base/callback.h"
   9 #include "base/memory/shared_memory.h"
  10 #include "gpu/command_buffer/common/command_buffer.h"
  11 #include "gpu/command_buffer/common/command_buffer_shared.h"
  12
  13 namespace gpu {
  14
  15 class TransferBufferManagerInterface;
  16
  17 class GPU_EXPORT CommandBufferServiceBase : public CommandBuffer {
  18  public:
  19   // Sets the current get offset. This can be called from any thread.
  20   virtual void SetGetOffset(int32 get_offset) = 0;
  21
  22   // Get the transfer buffer associated with an ID. Returns a null buffer for
  23   // ID 0.
  24   virtual scoped_refptr<gpu::Buffer> GetTransferBuffer(int32 id) = 0;
  25
  26   // Allows the reader to update the current token value.
  27   virtual void SetToken(int32 token) = 0;
  28
  29   // Allows the reader to set the current parse error.
  30   virtual void SetParseError(error::Error) = 0;
  31
  32   // Allows the reader to set the current context lost reason.
  33   // NOTE: if calling this in conjunction with SetParseError,
  34   // call this first.
  35   virtual void SetContextLostReason(error::ContextLostReason) = 0;
  36
  37   // Allows the reader to obtain the current put offset.
  38   virtual int32 GetPutOffset() = 0;
  39 };
  40
  41 // An object that implements a shared memory command buffer and a synchronous
  42 // API to manage the put and get pointers.
  43 class GPU_EXPORT CommandBufferService : public CommandBufferServiceBase {
  44  public:
  45   typedef base::Callback<bool(int32)> GetBufferChangedCallback;
  46   explicit CommandBufferService(
  47       TransferBufferManagerInterface* transfer_buffer_manager);
  48   ~CommandBufferService() override;
  49
  50   // CommandBuffer implementation:
  51   bool Initialize() override;
  52   State GetLastState() override;
  53   int32 GetLastToken() override;
  54   void Flush(int32 put_offset) override;
  55   void WaitForTokenInRange(int32 start, int32 end) override;
  56   void WaitForGetOffsetInRange(int32 start, int32 end) override;
  57   void SetGetBuffer(int32 transfer_buffer_id) override;
  58   scoped_refptr<Buffer> CreateTransferBuffer(size_t size, int32* id) override;
  59   void DestroyTransferBuffer(int32 id) override;
  60
  61   // CommandBufferServiceBase implementation:
  62   void SetGetOffset(int32 get_offset) override;
  63   scoped_refptr<Buffer> GetTransferBuffer(int32 id) override;
  64   void SetToken(int32 token) override;
  65   void SetParseError(error::Error error) override;
  66   void SetContextLostReason(error::ContextLostReason) override;
  67   int32 GetPutOffset() override;
  68
  69   // Sets a callback that is called whenever the put offset is changed. When
  70   // called with sync==true, the callback must not return until some progress
  71   // has been made (unless the command buffer is empty), i.e. the get offset
  72   // must have changed. It need not process the entire command buffer though.
  73   // This allows concurrency between the writer and the reader while giving the
  74   // writer a means of waiting for the reader to make some progress before
  75   // attempting to write more to the command buffer. Takes ownership of
  76   // callback.
  77   virtual void SetPutOffsetChangeCallback(const base::Closure& callback);
  78   // Sets a callback that is called whenever the get buffer is changed.
  79   virtual void SetGetBufferChangeCallback(
  80       const GetBufferChangedCallback& callback);
  81   virtual void SetParseErrorCallback(const base::Closure& callback);
  82
  83   // Setup the shared memory that shared state should be copied into.
  84   void SetSharedStateBuffer(scoped_ptr<BufferBacking> shared_state_buffer);
  85
  86   // Copy the current state into the shared state transfer buffer.
  87   void UpdateState();
  88
  89   // Registers an existing shared memory object and get an ID that can be used
  90   // to identify it in the command buffer.
  91   bool RegisterTransferBuffer(int32 id, scoped_ptr<BufferBacking> buffer);
  92
  93  private:
  94   int32 ring_buffer_id_;
  95   scoped_refptr<Buffer> ring_buffer_;
  96   scoped_ptr<BufferBacking> shared_state_buffer_;
  97   CommandBufferSharedState* shared_state_;
  98   int32 num_entries_;
  99   int32 get_offset_;
 100   int32 put_offset_;
 101   base::Closure put_offset_change_callback_;
 102   GetBufferChangedCallback get_buffer_change_callback_;
 103   base::Closure parse_error_callback_;
 104   TransferBufferManagerInterface* transfer_buffer_manager_;
 105   int32 token_;
 106   uint32 generation_;
 107   error::Error error_;
 108   error::ContextLostReason context_lost_reason_;
 109
 110   DISALLOW_COPY_AND_ASSIGN(CommandBufferService);
 111 };
 112
 113 }  // namespace gpu
 114
 115 #endif  // GPU_COMMAND_BUFFER_SERVICE_COMMAND_BUFFER_SERVICE_H_