Re-land: cc: Add raster finished signals to RasterWorkerPool.

cc/resources/pixel_buffer_raster_worker_pool.cc

 // Copyright 2013 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 "cc/resources/pixel_buffer_raster_worker_pool.h"
 
+#include <vector>
+
 #include "base/debug/trace_event.h"
 #include "cc/resources/resource.h"
 #include "third_party/skia/include/core/SkDevice.h"
 
 namespace cc {
 
 namespace {
 
 class PixelBufferWorkerPoolTaskImpl : public internal::WorkerPoolTask {
  public:
@@ skipping 60 matching lines @@
 
 const int kCheckForCompletedRasterTasksDelayMs = 6;
 
 const size_t kMaxPendingRasterBytes =
     kMaxBytesUploadedPerMs * kCheckForCompletedRasterTasksDelayMs;
 
 }  // namespace
 
 PixelBufferRasterWorkerPool::PixelBufferRasterWorkerPool(
     ResourceProvider* resource_provider,
-    size_t num_threads) : RasterWorkerPool(resource_provider, num_threads),
-                          shutdown_(false),
-                          bytes_pending_upload_(0),
-                          has_performed_uploads_since_last_flush_(false),
-                          check_for_completed_raster_tasks_pending_(false) {
+    size_t num_threads)
+    : RasterWorkerPool(resource_provider, num_threads),
+      shutdown_(false),
+      bytes_pending_upload_(0),
+      has_performed_uploads_since_last_flush_(false),
+      check_for_completed_raster_tasks_pending_(false),
+      finished_running_tasks_pending_(false),
+      finished_running_tasks_required_for_activation_pending_(false) {
 }
 
 PixelBufferRasterWorkerPool::~PixelBufferRasterWorkerPool() {
   DCHECK(shutdown_);
   DCHECK(!check_for_completed_raster_tasks_pending_);
   DCHECK_EQ(0u, pixel_buffer_tasks_.size());
   DCHECK_EQ(0u, tasks_with_pending_upload_.size());
   DCHECK_EQ(0u, completed_tasks_.size());
 }
 
 void PixelBufferRasterWorkerPool::Shutdown() {
   shutdown_ = true;
   RasterWorkerPool::Shutdown();
-  CheckForCompletedRasterTasks();
+  RasterWorkerPool::CheckForCompletedTasks();
+  CheckForCompletedUploads();
+  check_for_completed_raster_tasks_callback_.Cancel();
+  check_for_completed_raster_tasks_pending_ = false;
   for (TaskMap::iterator it = pixel_buffer_tasks_.begin();
        it != pixel_buffer_tasks_.end(); ++it) {
     internal::RasterWorkerPoolTask* task = it->first;
     internal::WorkerPoolTask* pixel_buffer_task = it->second.get();
 
     // All inactive tasks needs to be canceled.
     if (!pixel_buffer_task && !task->HasFinishedRunning()) {
       task->DidRun(true);
       completed_tasks_.push_back(task);
     }
   }
+  DCHECK_EQ(completed_tasks_.size(), pixel_buffer_tasks_.size());
 }
 
 void PixelBufferRasterWorkerPool::ScheduleTasks(RasterTask::Queue* queue) {
   TRACE_EVENT0("cc", "PixelBufferRasterWorkerPool::ScheduleTasks");
 
   RasterWorkerPool::SetRasterTasks(queue);
 
+  finished_running_tasks_pending_ = true;
+  finished_running_tasks_required_for_activation_pending_ = true;
+
   // Build new pixel buffer task set.
   TaskMap new_pixel_buffer_tasks;
   for (RasterTaskVector::const_iterator it = raster_tasks().begin();
        it != raster_tasks().end(); ++it) {
     internal::RasterWorkerPoolTask* task = it->get();
     DCHECK(new_pixel_buffer_tasks.find(task) == new_pixel_buffer_tasks.end());
     DCHECK(!task->HasCompleted());
 
     // Use existing pixel buffer task if available.
     TaskMap::iterator pixel_buffer_it = pixel_buffer_tasks_.find(task);
@@ skipping 19 matching lines @@
     // Inactive task can be canceled.
     if (!pixel_buffer_task && !task->HasFinishedRunning()) {
       task->DidRun(true);
       DCHECK(std::find(completed_tasks_.begin(),
                        completed_tasks_.end(),
                        task) == completed_tasks_.end());
       completed_tasks_.push_back(task);
     }
   }
 
+  tasks_required_for_activation_.clear();
+  for (TaskMap::iterator it = new_pixel_buffer_tasks.begin();
+       it != new_pixel_buffer_tasks.end(); ++it) {
+    internal::RasterWorkerPoolTask* task = it->first;
+    if (IsRasterTaskRequiredForActivation(task))
+      tasks_required_for_activation_.insert(task);
+  }
+
   pixel_buffer_tasks_.swap(new_pixel_buffer_tasks);
 
-  // This will schedule more tasks after checking for completed raster
-  // tasks. It's worth checking for completed tasks when ScheduleTasks()
-  // is called as priorities might have changed and this allows us to
-  // schedule as many new top priority tasks as possible.
-  CheckForCompletedRasterTasks();
+  // Check for completed tasks when ScheduleTasks() is called as
+  // priorities might have changed and this maximizes the number
+  // of top priority tasks that are scheduled.
+  RasterWorkerPool::CheckForCompletedTasks();
+  CheckForCompletedUploads();
+  FlushUploads();
+
+  // Schedule new tasks.
+  ScheduleMoreTasks();
+
+  // Cancel any pending check for completed raster tasks and schedule
+  // another check.
+  check_for_completed_raster_tasks_callback_.Cancel();
+  check_for_completed_raster_tasks_pending_ = false;
+  ScheduleCheckForCompletedRasterTasks();
 }
 
 void PixelBufferRasterWorkerPool::CheckForCompletedTasks() {
   TRACE_EVENT0("cc", "PixelBufferRasterWorkerPool::CheckForCompletedTasks");
 
   RasterWorkerPool::CheckForCompletedTasks();
   CheckForCompletedUploads();
   FlushUploads();
 
-  while (!completed_tasks_.empty()) {
-    internal::RasterWorkerPoolTask* task = completed_tasks_.front().get();
+  TaskDeque completed_tasks;
+  completed_tasks_.swap(completed_tasks);
+
+  while (!completed_tasks.empty()) {
+    internal::RasterWorkerPoolTask* task = completed_tasks.front().get();
     DCHECK(pixel_buffer_tasks_.find(task) != pixel_buffer_tasks_.end());
 
     pixel_buffer_tasks_.erase(task);
 
     task->WillComplete();
     task->CompleteOnOriginThread();
     task->DidComplete();
 
-    completed_tasks_.pop_front();
+    completed_tasks.pop_front();
   }
 }
 
 void PixelBufferRasterWorkerPool::OnRasterTasksFinished() {
-  // Call CheckForCompletedTasks() when we've finished running all raster
-  // tasks needed since last time ScheduleMoreTasks() was called. This
+  // Call CheckForCompletedRasterTasks() when we've finished running all
+  // raster tasks needed since last time ScheduleTasks() was called. This
   // reduces latency when processing only a small number of raster tasks.
   CheckForCompletedRasterTasks();
 }
 
+void PixelBufferRasterWorkerPool::OnRasterTasksRequiredForActivationFinished() {
+  // Handle this the same way as when finished running all raster tasks.
+  OnRasterTasksFinished();
+}
+
 void PixelBufferRasterWorkerPool::FlushUploads() {
   if (!has_performed_uploads_since_last_flush_)
     return;
 
   resource_provider()->ShallowFlushIfSupported();
   has_performed_uploads_since_last_flush_ = false;
 }
 
 void PixelBufferRasterWorkerPool::CheckForCompletedUploads() {
   TaskDeque tasks_with_completed_uploads;
@@ skipping 55 matching lines @@
 
     bytes_pending_upload_ -= task->resource()->bytes();
 
     task->DidRun(false);
 
     DCHECK(std::find(completed_tasks_.begin(),
                      completed_tasks_.end(),
                      task) == completed_tasks_.end());
     completed_tasks_.push_back(task);
 
+    tasks_required_for_activation_.erase(task);
+
     tasks_with_completed_uploads.pop_front();
   }
 }
 
 void PixelBufferRasterWorkerPool::ScheduleCheckForCompletedRasterTasks() {
   if (check_for_completed_raster_tasks_pending_)
     return;
 
   check_for_completed_raster_tasks_callback_.Reset(
       base::Bind(&PixelBufferRasterWorkerPool::CheckForCompletedRasterTasks,
                  base::Unretained(this)));
   base::MessageLoopProxy::current()->PostDelayedTask(
       FROM_HERE,
       check_for_completed_raster_tasks_callback_.callback(),
       base::TimeDelta::FromMilliseconds(kCheckForCompletedRasterTasksDelayMs));
   check_for_completed_raster_tasks_pending_ = true;
 }
 
 void PixelBufferRasterWorkerPool::CheckForCompletedRasterTasks() {
   TRACE_EVENT0(
       "cc", "PixelBufferRasterWorkerPool::CheckForCompletedRasterTasks");
 
   check_for_completed_raster_tasks_callback_.Cancel();
   check_for_completed_raster_tasks_pending_ = false;
 
   RasterWorkerPool::CheckForCompletedTasks();
   CheckForCompletedUploads();
   FlushUploads();
 
-  ScheduleMoreTasks();
+  // Determine if client should be notified and update pending notification
+  // status before scheduling more raster tasks.
+  bool notify_client_that_finished_running_tasks_required_for_activation =
+      NotifyClientThatFinishedRunningTasksRequiredForActivation();

[vmpstr, 2013/06/28 18:12:35]

Maybe something like AreTaskRequiredForActivationFinished? Since you moved the
actual client notification out of there, the name doesn't have to include
"NotifyClient" in it.

[reveman, 2013/06/28 20:18:41]

Cleaned this up a bit in latest patch. Let me know what you think.

+  bool notify_client_that_finished_running_tasks =
+      NotifyClientThatFinishedRunningTasks();
 
-  // Make sure another check for completed uploads is scheduled
-  // while there is still pending uploads left.
-  if (!tasks_with_pending_upload_.empty())
+  if (PendingRasterTaskCount())
+    ScheduleMoreTasks();
+
+  // Schedule another check for completed raster tasks while there are
+  // pending raster tasks or pending uploads.
+  if (PendingRasterTaskCount() || !tasks_with_pending_upload_.empty())
     ScheduleCheckForCompletedRasterTasks();
+
+  if (notify_client_that_finished_running_tasks_required_for_activation)
+    client()->DidFinishedRunningTasksRequiredForActivation();
+  if (notify_client_that_finished_running_tasks)
+    client()->DidFinishedRunningTasks();
 }
 
 void PixelBufferRasterWorkerPool::ScheduleMoreTasks() {
   TRACE_EVENT0("cc", "PixelBufferRasterWorkerPool::ScheduleMoreTasks");
 
+  enum RasterTaskType {
+    PREPAINT_TYPE = 0,
+    REQUIRED_FOR_ACTIVATION_TYPE = 1,
+    NUM_TYPES = 2
+  };
+  // TODO(reveman): Use StackVector instead.
+  std::vector<GraphNode*> tasks[NUM_TYPES];
+  unsigned priority = 2u;  // 0-1 reserved for RasterFinished tasks.
+  TaskGraph graph;
+
   size_t bytes_pending_upload = bytes_pending_upload_;
   size_t bytes_pending_raster = 0;
 
-  RasterTaskGraph graph;
   for (RasterTaskVector::const_iterator it = raster_tasks().begin();
        it != raster_tasks().end(); ++it) {
     internal::RasterWorkerPoolTask* task = it->get();
 
     // |pixel_buffer_tasks_| contains all tasks that have not yet completed.
     TaskMap::iterator pixel_buffer_it = pixel_buffer_tasks_.find(task);
     if (pixel_buffer_it == pixel_buffer_tasks_.end())
       continue;
 
     // HasFinishedRunning() will return true when set pixels has completed.
@@ skipping 23 matching lines @@
     size_t new_bytes_pending_raster = bytes_pending_raster;
     new_bytes_pending_raster += task->resource()->bytes();
     if (new_bytes_pending_raster > kMaxPendingRasterBytes)
       break;
 
     // Update both |bytes_pending_raster| and |bytes_pending_upload|
     // now that task has cleared all throttling limits.
     bytes_pending_raster = new_bytes_pending_raster;
     bytes_pending_upload = new_bytes_pending_upload;
 
+    RasterTaskType type = IsRasterTaskRequiredForActivation(task) ?
+        REQUIRED_FOR_ACTIVATION_TYPE :
+        PREPAINT_TYPE;
+
     // Use existing pixel buffer task if available.
     if (pixel_buffer_task) {
-      graph.InsertRasterTask(pixel_buffer_task, task->dependencies());
+      tasks[type].push_back(
+          CreateGraphNodeForRasterTask(pixel_buffer_task,
+                                       task->dependencies(),
+                                       priority++,
+                                       &graph));
       continue;
     }
 
     // Request a pixel buffer. This will reserve shared memory.
     resource_provider()->AcquirePixelBuffer(task->resource()->id());
 
     // MapPixelBuffer() returns NULL if context was lost at the time
     // AcquirePixelBuffer() was called. For simplicity we still post
     // a raster task that is essentially a noop in these situations.
     uint8* buffer = resource_provider()->MapPixelBuffer(
         task->resource()->id());
 
     scoped_refptr<internal::WorkerPoolTask> new_pixel_buffer_task(
         new PixelBufferWorkerPoolTaskImpl(
             task,
             buffer,
             base::Bind(&PixelBufferRasterWorkerPool::OnRasterTaskCompleted,
                        base::Unretained(this),
                        make_scoped_refptr(task))));
     pixel_buffer_tasks_[task] = new_pixel_buffer_task;
-    graph.InsertRasterTask(new_pixel_buffer_task.get(), task->dependencies());
+    tasks[type].push_back(
+        CreateGraphNodeForRasterTask(new_pixel_buffer_task.get(),
+                                     task->dependencies(),
+                                     priority++,
+                                     &graph));
   }
 
-  SetRasterTaskGraph(&graph);
+  scoped_refptr<internal::WorkerPoolTask>
+      new_raster_required_for_activation_finished_task;
 
-  // At least one task that could need an upload is now pending, schedule
-  // a check for completed raster tasks to ensure this upload is dispatched
-  // without too much latency.
-  if (bytes_pending_raster)
-    ScheduleCheckForCompletedRasterTasks();
+  DCHECK_LE(tasks[REQUIRED_FOR_ACTIVATION_TYPE].size(),
+            tasks_required_for_activation_.size());
+  // Schedule OnRasterTasksRequiredForActivationFinished call when

[vmpstr, 2013/06/28 18:12:35]

nit: Schedule OnRaster.. call only when

[reveman, 2013/06/28 20:18:41]

Done.

+  // notification is pending and throttling is not preventing
+  // all pending tasks required for activation from being scheduled.
+  if (tasks[REQUIRED_FOR_ACTIVATION_TYPE].size() ==
+      tasks_required_for_activation_.size() &&
+      finished_running_tasks_required_for_activation_pending_) {
+    new_raster_required_for_activation_finished_task =
+        CreateRasterRequiredForActivationFinishedTask();
+    GraphNode* raster_required_for_activation_finished_node =
+        CreateGraphNodeForTask(
+            new_raster_required_for_activation_finished_task.get(),
+            0u,  // Priority 0
+            &graph);
+    for (unsigned j = 0;

[vmpstr, 2013/06/28 18:12:35]

I still think this loop, and the inner loop around line 507 can be a small
separate function. But we can leave that for a clean up followup

[reveman, 2013/06/28 20:18:41]

Move inner loop to a separate function.

+         j < tasks[REQUIRED_FOR_ACTIVATION_TYPE].size();
+         ++j) {
+      raster_required_for_activation_finished_node->add_dependency();
+      tasks[REQUIRED_FOR_ACTIVATION_TYPE][j]->add_dependent(
+          raster_required_for_activation_finished_node);
+    }
+  }
+
+  scoped_refptr<internal::WorkerPoolTask> new_raster_finished_task;
+
+  DCHECK_LE(tasks[PREPAINT_TYPE].size() +
+            tasks[REQUIRED_FOR_ACTIVATION_TYPE].size(),
+            PendingRasterTaskCount());
+  // Schedule OnRasterTasksFinished call when notification is pending

[vmpstr, 2013/06/28 18:12:35]

nit: ... only when ...

[reveman, 2013/06/28 20:18:41]

Done.

+  // and throttling is not preventing all pending tasks from being
+  // scheduled.
+  if ((tasks[PREPAINT_TYPE].size() +
+       tasks[REQUIRED_FOR_ACTIVATION_TYPE].size()) ==
+      PendingRasterTaskCount() &&
+      finished_running_tasks_pending_) {
+    new_raster_finished_task = CreateRasterFinishedTask();
+    GraphNode* raster_finished_node =
+        CreateGraphNodeForTask(new_raster_finished_task.get(),
+                               1u,  // Priority 1
+                               &graph);
+    for (unsigned type = 0; type < NUM_TYPES; ++type) {
+      for (unsigned i = 0; i < tasks[type].size(); ++i) {
+        raster_finished_node->add_dependency();
+        tasks[type][i]->add_dependent(raster_finished_node);
+      }
+    }
+  }
+
+  SetTaskGraph(&graph);
+
+  set_raster_finished_task(new_raster_finished_task);
+  set_raster_required_for_activation_finished_task(
+      new_raster_required_for_activation_finished_task);
 }
 
 void PixelBufferRasterWorkerPool::OnRasterTaskCompleted(
     scoped_refptr<internal::RasterWorkerPoolTask> task,
     bool was_canceled,
     bool needs_upload) {
   TRACE_EVENT2("cc", "PixelBufferRasterWorkerPool::OnRasterTaskCompleted",
                "was_canceled", was_canceled,
                "needs_upload", needs_upload);
 
   DCHECK(pixel_buffer_tasks_.find(task.get()) != pixel_buffer_tasks_.end());
 
   // Balanced with MapPixelBuffer() call in ScheduleMoreTasks().
   resource_provider()->UnmapPixelBuffer(task->resource()->id());
 
   if (!needs_upload) {
     resource_provider()->ReleasePixelBuffer(task->resource()->id());
     task->DidRun(was_canceled);
     DCHECK(std::find(completed_tasks_.begin(),
                      completed_tasks_.end(),
                      task) == completed_tasks_.end());
     completed_tasks_.push_back(task);
+    tasks_required_for_activation_.erase(task);
     return;
   }
 
   resource_provider()->BeginSetPixels(task->resource()->id());
   has_performed_uploads_since_last_flush_ = true;
 
   bytes_pending_upload_ += task->resource()->bytes();
   tasks_with_pending_upload_.push_back(task);
 }
 
+unsigned PixelBufferRasterWorkerPool::PendingRasterTaskCount() const {
+  unsigned num_completed_raster_tasks =
+      tasks_with_pending_upload_.size() + completed_tasks_.size();
+  DCHECK_GE(pixel_buffer_tasks_.size(), num_completed_raster_tasks);
+  return pixel_buffer_tasks_.size() - num_completed_raster_tasks;
+}
+
+bool PixelBufferRasterWorkerPool::
+    NotifyClientThatFinishedRunningTasksRequiredForActivation() {
+  if (!finished_running_tasks_required_for_activation_pending_)
+    return false;
+
+  if (!tasks_required_for_activation_.empty())
+    return false;
+
+  finished_running_tasks_required_for_activation_pending_ = false;
+  return true;
+}
+
+bool PixelBufferRasterWorkerPool::NotifyClientThatFinishedRunningTasks() {
+  if (!finished_running_tasks_pending_)
+    return false;
+
+  if (PendingRasterTaskCount())
+    return false;
+
+  if (!tasks_with_pending_upload_.empty())
+    return false;
+
+  finished_running_tasks_pending_ = false;
+  return true;
+}
+
 }  // namespace cc