gpu: Move out of order / control message handling to message filter.

gpu/ipc/service/gpu_channel.h

 // 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.
 
 #ifndef GPU_IPC_SERVICE_GPU_CHANNEL_H_
 #define GPU_IPC_SERVICE_GPU_CHANNEL_H_
 
 #include <stddef.h>
 #include <stdint.h>
 
@@ skipping 140 matching lines @@
 
   scoped_refptr<gl::GLImage> CreateImageForGpuMemoryBuffer(
       const gfx::GpuMemoryBufferHandle& handle,
       const gfx::Size& size,
       gfx::BufferFormat format,
       uint32_t internalformat,
       SurfaceHandle surface_handle);
 
   GpuChannelMessageFilter* filter() const { return filter_.get(); }
 
-  void PostHandleOutOfOrderMessage(const IPC::Message& message);
-  void PostHandleMessage();
+  // Handle messages enqueued in |message_queue_|.
+  void HandleMessageOnQueue();
+
+  // Some messages such as WaitForGetOffsetInRange and WaitForTokenInRange are
+  // processed as soon as possible because the client is blocked until they
+  // are completed.
+  void HandleOutOfOrderMessage(const IPC::Message& msg);
 
   // Synchronously handle the message to make testing convenient.
   void HandleMessageForTesting(const IPC::Message& msg);
 
 #if defined(OS_ANDROID)
   const GpuCommandBufferStub* GetOneStub() const;
 #endif
 
  protected:
   scoped_refptr<GpuChannelMessageQueue> message_queue_;
 
   // The message filter on the io thread.
   scoped_refptr<GpuChannelMessageFilter> filter_;
 
   // Map of routing id to command buffer stub.
   std::unordered_map<int32_t, std::unique_ptr<GpuCommandBufferStub>> stubs_;
 
  private:
   friend class TestGpuChannel;
 
   bool OnControlMessageReceived(const IPC::Message& msg);
 
-  void HandleMessage();
-
-  // Some messages such as WaitForGetOffsetInRange and WaitForTokenInRange are
-  // processed as soon as possible because the client is blocked until they
-  // are completed.
-  void HandleOutOfOrderMessage(const IPC::Message& msg);
-
   void HandleMessageHelper(const IPC::Message& msg);
 
   // Message handlers for control messages.
   void OnCreateCommandBuffer(const GPUCreateCommandBufferConfig& init_params,
                              int32_t route_id,
                              base::SharedMemoryHandle shared_state_shm,
                              bool* result,
                              gpu::Capabilities* capabilities);
   void OnDestroyCommandBuffer(int32_t route_id);
   void OnGetDriverBugWorkArounds(
       std::vector<std::string>* gpu_driver_bug_workarounds);
 
   std::unique_ptr<GpuCommandBufferStub> CreateCommandBuffer(
       const GPUCreateCommandBufferConfig& init_params,
       int32_t route_id,
       std::unique_ptr<base::SharedMemory> shared_state_shm);
 
   // The lifetime of objects of this class is managed by a GpuChannelManager.
   // The GpuChannelManager destroy all the GpuChannels that they own when they
   // are destroyed. So a raw pointer is safe.
   GpuChannelManager* const gpu_channel_manager_;
 
   // Sync point manager. Outlives the channel and is guaranteed to outlive the
   // message loop.
   SyncPointManager* const sync_point_manager_;
 
   std::unique_ptr<IPC::SyncChannel> channel_;
 
-  IPC::Listener* unhandled_message_listener_;
+  IPC::Listener* unhandled_message_listener_ = nullptr;
 
   // Used to implement message routing functionality to CommandBuffer objects
   IPC::MessageRouter router_;
 
   // Whether the processing of IPCs on this channel is stalled and we should
   // preempt other GpuChannels.
   scoped_refptr<PreemptionFlag> preempting_flag_;
 
   // If non-NULL, all stubs on this channel should stop processing GL
   // commands (via their CommandExecutor) when preempted_flag_->IsSet()
@@ skipping 16 matching lines @@
   scoped_refptr<gles2::MailboxManager> mailbox_manager_;
 
   GpuWatchdogThread* const watchdog_;
 
   // Can view command buffers be created on this channel.
   const bool allow_view_command_buffers_;
 
   // Can real time streams be created on this channel.
   const bool allow_real_time_streams_;
 
-  base::ProcessId peer_pid_;
+  base::ProcessId peer_pid_ = base::kNullProcessId;
 
-  // Member variables should appear before the WeakPtrFactory, to ensure
-  // that any WeakPtrs to Controller are invalidated before its members
-  // variable's destructors are executed, rendering them invalid.
+  // Member variables should appear before the WeakPtrFactory, to ensure that
+  // any WeakPtrs to Controller are invalidated before its members variable's
+  // destructors are executed, rendering them invalid.
   base::WeakPtrFactory<GpuChannel> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(GpuChannel);
 };
 
 // This filter does three things:
 // - it counts and timestamps each message forwarded to the channel
 //   so that we can preempt other channels if a message takes too long to
 //   process. To guarantee fairness, we must wait a minimum amount of time
 //   before preempting and we limit the amount of time that we can preempt in
 //   one shot (see constants above).
 // - it handles the GpuCommandBufferMsg_InsertSyncPoint message on the IO
 //   thread, generating the sync point ID and responding immediately, and then
 //   posting a task to insert the GpuCommandBufferMsg_RetireSyncPoint message
 //   into the channel's queue.
 // - it generates mailbox names for clients of the GPU process on the IO thread.
 class GPU_EXPORT GpuChannelMessageFilter : public IPC::MessageFilter {
  public:
-  explicit GpuChannelMessageFilter(
-      scoped_refptr<GpuChannelMessageQueue> message_queue);
+  GpuChannelMessageFilter(
+      GpuChannel* gpu_channel,
+      scoped_refptr<GpuChannelMessageQueue> message_queue,
+      scoped_refptr<base::SingleThreadTaskRunner> main_task_runner);
+
+  void Destroy();
 
   // IPC::MessageFilter implementation.
   void OnFilterAdded(IPC::Channel* channel) override;
   void OnFilterRemoved() override;
   void OnChannelConnected(int32_t peer_pid) override;
   void OnChannelError() override;
   void OnChannelClosing() override;
   bool OnMessageReceived(const IPC::Message& message) override;
 
   void AddChannelFilter(scoped_refptr<IPC::MessageFilter> filter);
   void RemoveChannelFilter(scoped_refptr<IPC::MessageFilter> filter);
 
   bool Send(IPC::Message* message);
 
- protected:
+ private:
   ~GpuChannelMessageFilter() override;
 
- private:
   bool MessageErrorHandler(const IPC::Message& message, const char* error_msg);
 
+  IPC::Channel* ipc_channel_ = nullptr;
+  base::ProcessId peer_pid_ = base::kNullProcessId;
+  std::vector<scoped_refptr<IPC::MessageFilter>> channel_filters_;
+
+  GpuChannel* gpu_channel_ = nullptr;
+  base::Lock gpu_channel_lock_;
+
   scoped_refptr<GpuChannelMessageQueue> message_queue_;
-
-  IPC::Channel* channel_;
-  base::ProcessId peer_pid_;
-  std::vector<scoped_refptr<IPC::MessageFilter>> channel_filters_;
+  scoped_refptr<base::SingleThreadTaskRunner> main_task_runner_;
 
   DISALLOW_COPY_AND_ASSIGN(GpuChannelMessageFilter);
 };
 
 struct GpuChannelMessage {
   IPC::Message message;
   uint32_t order_number;
   base::TimeTicks time_received;
 
   GpuChannelMessage(const IPC::Message& msg,
                     uint32_t order_num,
                     base::TimeTicks ts)
       : message(msg), order_number(order_num), time_received(ts) {}
 
  private:
   DISALLOW_COPY_AND_ASSIGN(GpuChannelMessage);
 };
 
 class GpuChannelMessageQueue
     : public base::RefCountedThreadSafe<GpuChannelMessageQueue> {
  public:
-  static scoped_refptr<GpuChannelMessageQueue> Create(
+  GpuChannelMessageQueue(
       GpuChannel* channel,
+      scoped_refptr<base::SingleThreadTaskRunner> main_task_runner,
       scoped_refptr<base::SingleThreadTaskRunner> io_task_runner,
       scoped_refptr<PreemptionFlag> preempting_flag,
       scoped_refptr<PreemptionFlag> preempted_flag,
       SyncPointManager* sync_point_manager);
 
-  void Disable();
-  void DisableIO();
+  void Destroy();
 
   SequenceId sequence_id() const {
     return sync_point_order_data_->sequence_id();
   }
 
   bool IsScheduled() const;
   void SetScheduled(bool scheduled);
 
   bool HasQueuedMessages() const;
 
-  base::TimeTicks GetNextMessageTimeTick() const;
-
   // Should be called before a message begins to be processed. Returns false if
   // there are no messages to process.
   const GpuChannelMessage* BeginMessageProcessing();
   // Should be called if a message began processing but did not finish.
   void PauseMessageProcessing();
   // Should be called if a message is completely processed. Returns true if
   // there are more messages to process.
   void FinishMessageProcessing();
 
-  bool PushBackMessage(const IPC::Message& message);
+  void PushBackMessage(const IPC::Message& message);
 
  private:
   enum PreemptionState {
     // Either there's no other channel to preempt, there are no messages
     // pending processing, or we just finished preempting and have to wait
     // before preempting again.
     IDLE,
     // We are waiting kPreemptWaitTimeMs before checking if we should preempt.
     WAITING,
     // We can preempt whenever any IPC processing takes more than
     // kPreemptWaitTimeMs.
     CHECKING,
     // We are currently preempting (i.e. no stub is descheduled).
     PREEMPTING,
     // We would like to preempt, but some stub is descheduled.
     WOULD_PREEMPT_DESCHEDULED,
   };
 
   friend class base::RefCountedThreadSafe<GpuChannelMessageQueue>;
 
-  GpuChannelMessageQueue(
-      GpuChannel* channel,
-      scoped_refptr<base::SingleThreadTaskRunner> io_task_runner,
-      scoped_refptr<PreemptionFlag> preempting_flag,
-      scoped_refptr<PreemptionFlag> preempted_flag,
-      SyncPointManager* sync_point_manager);
   ~GpuChannelMessageQueue();
 
+  void PostHandleMessageOnQueue();
+
   void UpdatePreemptionState();
   void UpdatePreemptionStateHelper();
 
   void UpdateStateIdle();
   void UpdateStateWaiting();
   void UpdateStateChecking();
   void UpdateStatePreempting();
   void UpdateStateWouldPreemptDescheduled();
 
   void TransitionToIdle();
   void TransitionToWaiting();
   void TransitionToChecking();
   void TransitionToPreempting();
   void TransitionToWouldPreemptDescheduled();
 
   bool ShouldTransitionToIdle() const;
 
   // These can be accessed from both IO and main threads and are protected by
   // |channel_lock_|.
-  bool enabled_;
-  bool scheduled_;
-  GpuChannel* const channel_;
+  bool scheduled_ = true;
+  GpuChannel* channel_ = nullptr;  // set to nullptr on Destroy
   std::deque<std::unique_ptr<GpuChannelMessage>> channel_messages_;
+  bool handle_message_post_task_pending_ = false;
   mutable base::Lock channel_lock_;
 
   // The following are accessed on the IO thread only.
   // No lock is necessary for preemption state because it's only accessed on the
   // IO thread.
-  PreemptionState preemption_state_;
+  PreemptionState preemption_state_ = IDLE;
   // Maximum amount of time that we can spend in PREEMPTING.
   // It is reset when we transition to IDLE.
   base::TimeDelta max_preemption_time_;
   // This timer is used and runs tasks on the IO thread.
   std::unique_ptr<base::OneShotTimer> timer_;
   base::ThreadChecker io_thread_checker_;
 
   // Keeps track of sync point related state such as message order numbers.
   scoped_refptr<SyncPointOrderData> sync_point_order_data_;
 
+  scoped_refptr<base::SingleThreadTaskRunner> main_task_runner_;
   scoped_refptr<base::SingleThreadTaskRunner> io_task_runner_;
   scoped_refptr<PreemptionFlag> preempting_flag_;
   scoped_refptr<PreemptionFlag> preempted_flag_;
   SyncPointManager* const sync_point_manager_;
 
   DISALLOW_COPY_AND_ASSIGN(GpuChannelMessageQueue);
 };
 
 }  // namespace gpu
 
 #endif  // GPU_IPC_SERVICE_GPU_CHANNEL_H_