Re-land: cc: Cleanup internal::WorkerPoolTaskClient interface.

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 "base/containers/stack_container.h"
 #include "base/debug/trace_event.h"
 #include "base/values.h"
 #include "cc/debug/traced_value.h"
 #include "cc/resources/resource.h"
 
 namespace cc {
 namespace {
 
 const int kCheckForCompletedRasterTasksDelayMs = 6;
 
 const size_t kMaxScheduledRasterTasks = 48;
 
 typedef base::StackVector<internal::WorkerPoolTask*, kMaxScheduledRasterTasks>
     WorkerPoolTaskVector;
 
 // Only used as std::find_if predicate for DCHECKs.
-bool WasCanceled(const internal::RasterWorkerPoolTask* task) {
+bool WasCanceled(const internal::WorkerPoolTask* task) {
   return !task->HasFinishedRunning();
 }
 
 }  // namespace
 
 // static
 scoped_ptr<RasterWorkerPool> PixelBufferRasterWorkerPool::Create(
     ResourceProvider* resource_provider,
     size_t max_transfer_buffer_usage_bytes) {
   return make_scoped_ptr<RasterWorkerPool>(
@@ skipping 35 matching lines @@
 
   CheckForCompletedWorkerPoolTasks();
   CheckForCompletedUploads();
 
   weak_factory_.InvalidateWeakPtrs();
   check_for_completed_raster_tasks_pending_ = false;
 
   for (RasterTaskStateMap::iterator it = raster_task_states_.begin();
        it != raster_task_states_.end();
        ++it) {
-    internal::RasterWorkerPoolTask* task = it->first;
+    internal::WorkerPoolTask* task = it->first;
+    RasterTaskState& state = it->second;
 
     // All unscheduled tasks need to be canceled.
-    if (it->second == UNSCHEDULED) {
+    if (state.type == RasterTaskState::UNSCHEDULED) {
       completed_raster_tasks_.push_back(task);
-      it->second = COMPLETED;
+      state.type = RasterTaskState::COMPLETED;
     }
   }
   DCHECK_EQ(completed_raster_tasks_.size(), raster_task_states_.size());
 }
 
 void PixelBufferRasterWorkerPool::ScheduleTasks(RasterTaskQueue* queue) {
   TRACE_EVENT0("cc", "PixelBufferRasterWorkerPool::ScheduleTasks");
 
   DCHECK_EQ(queue->required_for_activation_count,
             static_cast<size_t>(
                 std::count_if(queue->items.begin(),
                               queue->items.end(),
                               RasterTaskQueue::Item::IsRequiredForActivation)));
 
   if (!should_notify_client_if_no_tasks_are_pending_)
     TRACE_EVENT_ASYNC_BEGIN0("cc", "ScheduledTasks", this);
 
   should_notify_client_if_no_tasks_are_pending_ = true;
   should_notify_client_if_no_tasks_required_for_activation_are_pending_ = true;
 
   raster_tasks_required_for_activation_.clear();
 
   // Build new raster task state map.
   RasterTaskStateMap new_raster_task_states;
   for (RasterTaskQueue::Item::Vector::const_iterator it = queue->items.begin();
        it != queue->items.end();
        ++it) {
     const RasterTaskQueue::Item& item = *it;
-    internal::RasterWorkerPoolTask* task = item.task;
+    internal::WorkerPoolTask* task = item.task;
     DCHECK(new_raster_task_states.find(task) == new_raster_task_states.end());
 
     RasterTaskStateMap::iterator state_it = raster_task_states_.find(task);
     if (state_it != raster_task_states_.end()) {
-      RasterTaskState state = state_it->second;
+      RasterTaskState& state = state_it->second;
 
       new_raster_task_states[task] = state;
       // |raster_tasks_required_for_activation_| contains all tasks that need to
       // complete before we can send a "ready to activate" signal. Tasks that
       // have already completed should not be part of this set.
-      if (state != COMPLETED && item.required_for_activation)
+      if (state.type != RasterTaskState::COMPLETED &&
+          item.required_for_activation)
         raster_tasks_required_for_activation_.insert(task);
 
       raster_task_states_.erase(state_it);
     } else {
       DCHECK(!task->HasBeenScheduled());
-      new_raster_task_states[task] = UNSCHEDULED;
+      new_raster_task_states[task].type = RasterTaskState::UNSCHEDULED;
       if (item.required_for_activation)
         raster_tasks_required_for_activation_.insert(task);
     }
   }
 
   // Transfer old raster task state to |new_raster_task_states| and cancel all
   // remaining unscheduled tasks.
   for (RasterTaskStateMap::iterator it = raster_task_states_.begin();
        it != raster_task_states_.end();
        ++it) {
-    internal::RasterWorkerPoolTask* task = it->first;
+    internal::WorkerPoolTask* task = it->first;
+    RasterTaskState& state = it->second;
     DCHECK(new_raster_task_states.find(task) == new_raster_task_states.end());
 
     // Unscheduled task can be canceled.
-    if (it->second == UNSCHEDULED) {
+    if (state.type == RasterTaskState::UNSCHEDULED) {
       DCHECK(!task->HasBeenScheduled());
       DCHECK(std::find(completed_raster_tasks_.begin(),
                        completed_raster_tasks_.end(),
                        task) == completed_raster_tasks_.end());
       completed_raster_tasks_.push_back(task);
-      new_raster_task_states[task] = COMPLETED;
+      new_raster_task_states[task].type = RasterTaskState::COMPLETED;
       continue;
     }
 
     // Move state to |new_raster_task_states|.
-    new_raster_task_states[task] = it->second;
+    new_raster_task_states[task] = state;
   }
 
   raster_tasks_.Swap(queue);
   raster_task_states_.swap(new_raster_task_states);
 
   // 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.
   CheckForCompletedWorkerPoolTasks();
   CheckForCompletedUploads();
@@ skipping 34 matching lines @@
   while (!completed_image_decode_tasks_.empty()) {
     internal::WorkerPoolTask* task =
         completed_image_decode_tasks_.front().get();
 
     task->RunReplyOnOriginThread();
 
     completed_image_decode_tasks_.pop_front();
   }
 
   while (!completed_raster_tasks_.empty()) {
-    internal::RasterWorkerPoolTask* task =
-        completed_raster_tasks_.front().get();
+    internal::WorkerPoolTask* task = completed_raster_tasks_.front().get();
     DCHECK(raster_task_states_.find(task) != raster_task_states_.end());
-    DCHECK_EQ(COMPLETED, raster_task_states_[task]);
+    DCHECK_EQ(RasterTaskState::COMPLETED, raster_task_states_[task].type);
 
     raster_task_states_.erase(task);
 
     task->RunReplyOnOriginThread();
 
     completed_raster_tasks_.pop_front();
   }
 }
 
 SkCanvas* PixelBufferRasterWorkerPool::AcquireCanvasForRaster(
-    internal::RasterWorkerPoolTask* task) {
-  resource_provider()->AcquirePixelRasterBuffer(task->resource()->id());
-  return resource_provider()->MapPixelRasterBuffer(task->resource()->id());
+    internal::WorkerPoolTask* task,
+    const Resource* resource) {
+  DCHECK(raster_task_states_.find(task) != raster_task_states_.end());
+  DCHECK(!raster_task_states_[task].resource);
+  raster_task_states_[task].resource = resource;
+  resource_provider()->AcquirePixelRasterBuffer(resource->id());
+  return resource_provider()->MapPixelRasterBuffer(resource->id());
 }
 
-void PixelBufferRasterWorkerPool::OnRasterCompleted(
-    internal::RasterWorkerPoolTask* task,
-    const PicturePileImpl::Analysis& analysis) {
-  TRACE_EVENT2(TRACE_DISABLED_BY_DEFAULT("cc"),
-               "PixelBufferRasterWorkerPool::OnRasterCompleted",
-               "was_canceled",
-               !task->HasFinishedRunning(),
-               "needs_upload",
-               task->HasFinishedRunning() && !analysis.is_solid_color);
-
+void PixelBufferRasterWorkerPool::ReleaseCanvasForRaster(
+    internal::WorkerPoolTask* task,
+    const Resource* resource) {
   DCHECK(raster_task_states_.find(task) != raster_task_states_.end());
-  DCHECK_EQ(SCHEDULED, raster_task_states_[task]);
-
-  // Balanced with MapPixelRasterBuffer() call in AcquireCanvasForRaster().
-  resource_provider()->UnmapPixelRasterBuffer(task->resource()->id());
-
-  if (!task->HasFinishedRunning() || analysis.is_solid_color) {
-    resource_provider()->ReleasePixelRasterBuffer(task->resource()->id());
-
-    if (!task->HasFinishedRunning()) {
-      // When priorites change, a raster task can be canceled as a result of
-      // no longer being of high enough priority to fit in our throttled
-      // raster task budget. The task has not yet completed in this case.
-      for (RasterTaskQueue::Item::Vector::const_iterator it =
-               raster_tasks_.items.begin();
-           it != raster_tasks_.items.end();
-           ++it) {
-        if (it->task == task) {
-          raster_task_states_[task] = UNSCHEDULED;
-          return;
-        }
-      }
-    }
-
-    DCHECK(std::find(completed_raster_tasks_.begin(),
-                     completed_raster_tasks_.end(),
-                     task) == completed_raster_tasks_.end());
-    completed_raster_tasks_.push_back(task);
-    raster_task_states_[task] = COMPLETED;
-    raster_tasks_required_for_activation_.erase(task);
-    return;
-  }
-
-  DCHECK(task->HasFinishedRunning());
-
-  resource_provider()->BeginSetPixels(task->resource()->id());
-  has_performed_uploads_since_last_flush_ = true;
-
-  bytes_pending_upload_ += task->resource()->bytes();
-  raster_tasks_with_pending_upload_.push_back(task);
-  raster_task_states_[task] = UPLOADING;
-}
-
-void PixelBufferRasterWorkerPool::OnImageDecodeCompleted(
-    internal::WorkerPoolTask* task) {
-  completed_image_decode_tasks_.push_back(task);
+  DCHECK(raster_task_states_[task].resource == resource);
+  resource_provider()->ReleasePixelRasterBuffer(resource->id());
 }
 
 void PixelBufferRasterWorkerPool::OnRasterTasksFinished() {
   // |should_notify_client_if_no_tasks_are_pending_| can be set to false as
   // a result of a scheduled CheckForCompletedRasterTasks() call. No need to
   // perform another check in that case as we've already notified the client.
   if (!should_notify_client_if_no_tasks_are_pending_)
     return;
   raster_finished_task_pending_ = false;
 
@@ skipping 19 matching lines @@
 
 void PixelBufferRasterWorkerPool::FlushUploads() {
   if (!has_performed_uploads_since_last_flush_)
     return;
 
   resource_provider()->ShallowFlushIfSupported();
   has_performed_uploads_since_last_flush_ = false;
 }
 
 void PixelBufferRasterWorkerPool::CheckForCompletedUploads() {
-  RasterTaskDeque tasks_with_completed_uploads;
+  TaskDeque tasks_with_completed_uploads;
 
   // First check if any have completed.
   while (!raster_tasks_with_pending_upload_.empty()) {
-    internal::RasterWorkerPoolTask* task =
+    internal::WorkerPoolTask* task =
         raster_tasks_with_pending_upload_.front().get();
     DCHECK(raster_task_states_.find(task) != raster_task_states_.end());
-    DCHECK_EQ(UPLOADING, raster_task_states_[task]);
+    RasterTaskState& state = raster_task_states_[task];
+    DCHECK_EQ(RasterTaskState::UPLOADING, state.type);
 
     // Uploads complete in the order they are issued.
-    if (!resource_provider()->DidSetPixelsComplete(task->resource()->id()))
+    if (!resource_provider()->DidSetPixelsComplete(state.resource->id()))
       break;
 
     tasks_with_completed_uploads.push_back(task);
     raster_tasks_with_pending_upload_.pop_front();
   }
 
   DCHECK(client());
   bool should_force_some_uploads_to_complete =
       shutdown_ || client()->ShouldForceTasksRequiredForActivationToComplete();
 
   if (should_force_some_uploads_to_complete) {
-    RasterTaskDeque tasks_with_uploads_to_force;
-    RasterTaskDeque::iterator it = raster_tasks_with_pending_upload_.begin();
+    TaskDeque tasks_with_uploads_to_force;
+    TaskDeque::iterator it = raster_tasks_with_pending_upload_.begin();
     while (it != raster_tasks_with_pending_upload_.end()) {
-      internal::RasterWorkerPoolTask* task = it->get();
+      internal::WorkerPoolTask* task = it->get();
       DCHECK(raster_task_states_.find(task) != raster_task_states_.end());
 
       // Force all uploads required for activation to complete.
       // During shutdown, force all pending uploads to complete.
       if (shutdown_ || IsRasterTaskRequiredForActivation(task)) {
         tasks_with_uploads_to_force.push_back(task);
         tasks_with_completed_uploads.push_back(task);
         it = raster_tasks_with_pending_upload_.erase(it);
         continue;
       }
 
       ++it;
     }
 
     // Force uploads in reverse order. Since forcing can cause a wait on
     // all previous uploads, we would rather wait only once downstream.
-    for (RasterTaskDeque::reverse_iterator it =
-             tasks_with_uploads_to_force.rbegin();
+    for (TaskDeque::reverse_iterator it = tasks_with_uploads_to_force.rbegin();
          it != tasks_with_uploads_to_force.rend();
          ++it) {
-      resource_provider()->ForceSetPixelsToComplete((*it)->resource()->id());
+      internal::WorkerPoolTask* task = it->get();
+      RasterTaskState& state = raster_task_states_[task];
+      DCHECK(state.resource);
+
+      resource_provider()->ForceSetPixelsToComplete(state.resource->id());
       has_performed_uploads_since_last_flush_ = true;
     }
   }
 
   // Release shared memory and move tasks with completed uploads
   // to |completed_raster_tasks_|.
   while (!tasks_with_completed_uploads.empty()) {
-    internal::RasterWorkerPoolTask* task =
-        tasks_with_completed_uploads.front().get();
+    internal::WorkerPoolTask* task = tasks_with_completed_uploads.front().get();
+    RasterTaskState& state = raster_task_states_[task];
 
-    // It's now safe to release the pixel buffer and the shared memory.
-    resource_provider()->ReleasePixelRasterBuffer(task->resource()->id());
+    bytes_pending_upload_ -= state.resource->bytes();
 
-    bytes_pending_upload_ -= task->resource()->bytes();
+    task->WillComplete();
+    task->CompleteOnOriginThread(this);
+    task->DidComplete();
 
     DCHECK(std::find(completed_raster_tasks_.begin(),
                      completed_raster_tasks_.end(),
                      task) == completed_raster_tasks_.end());
     completed_raster_tasks_.push_back(task);
-    raster_task_states_[task] = COMPLETED;
+    state.type = RasterTaskState::COMPLETED;
 
     raster_tasks_required_for_activation_.erase(task);
 
     tasks_with_completed_uploads.pop_front();
   }
 }
 
 void PixelBufferRasterWorkerPool::ScheduleCheckForCompletedRasterTasks() {
   base::TimeDelta delay =
       base::TimeDelta::FromMilliseconds(kCheckForCompletedRasterTasksDelayMs);
@@ skipping 113 matching lines @@
        ++it) {
     const RasterTaskQueue::Item& item = *it;
     internal::RasterWorkerPoolTask* task = item.task;
 
     // |raster_task_states_| contains the state of all tasks that we have not
     // yet run reply callbacks for.
     RasterTaskStateMap::iterator state_it = raster_task_states_.find(task);
     if (state_it == raster_task_states_.end())
       continue;
 
+    RasterTaskState& state = state_it->second;
+
     // Skip task if completed.
-    if (state_it->second == COMPLETED) {
+    if (state.type == RasterTaskState::COMPLETED) {
       DCHECK(std::find(completed_raster_tasks_.begin(),
                        completed_raster_tasks_.end(),
                        task) != completed_raster_tasks_.end());
       continue;
     }
 
     // All raster tasks need to be throttled by bytes of pending uploads.
     size_t new_bytes_pending_upload = bytes_pending_upload;
     new_bytes_pending_upload += task->resource()->bytes();
     if (new_bytes_pending_upload > max_bytes_pending_upload_) {
       did_throttle_raster_tasks = true;
       break;
     }
 
     // If raster has finished, just update |bytes_pending_upload|.
-    if (state_it->second == UPLOADING) {
+    if (state.type == RasterTaskState::UPLOADING) {
       DCHECK(task->HasCompleted());
       bytes_pending_upload = new_bytes_pending_upload;
       continue;
     }
 
     // Throttle raster tasks based on kMaxScheduledRasterTasks.
     if (tasks.container().size() >= kMaxScheduledRasterTasks) {
       did_throttle_raster_tasks = true;
       break;
     }
 
     // Update |bytes_pending_upload| now that task has cleared all
     // throttling limits.
     bytes_pending_upload = new_bytes_pending_upload;
 
-    DCHECK(state_it->second == UNSCHEDULED || state_it->second == SCHEDULED);
-    state_it->second = SCHEDULED;
+    DCHECK(state.type == RasterTaskState::UNSCHEDULED ||
+           state.type == RasterTaskState::SCHEDULED);
+    state.type = RasterTaskState::SCHEDULED;
 
     InsertNodeForRasterTask(&graph_, task, task->dependencies(), priority++);
 
     tasks.container().push_back(task);
     if (item.required_for_activation)
       tasks_required_for_activation.container().push_back(task);
   }
 
   scoped_refptr<internal::WorkerPoolTask>
       new_raster_required_for_activation_finished_task;
@@ skipping 84 matching lines @@
 }
 
 void PixelBufferRasterWorkerPool::CheckForCompletedWorkerPoolTasks() {
   CollectCompletedWorkerPoolTasks(&completed_tasks_);
   for (internal::Task::Vector::const_iterator it = completed_tasks_.begin();
        it != completed_tasks_.end();
        ++it) {
     internal::WorkerPoolTask* task =
         static_cast<internal::WorkerPoolTask*>(it->get());
 
-    task->WillComplete();
-    task->CompleteOnOriginThread(this);
-    task->DidComplete();
+    RasterTaskStateMap::iterator state_it = raster_task_states_.find(task);
+    if (state_it == raster_task_states_.end()) {
+      task->WillComplete();
+      task->CompleteOnOriginThread(this);
+      task->DidComplete();
+
+      completed_image_decode_tasks_.push_back(task);
+      continue;
+    }
+
+    RasterTaskState& state = state_it->second;
+    DCHECK_EQ(RasterTaskState::SCHEDULED, state.type);
+    DCHECK(state.resource);
+
+    // Balanced with MapPixelRasterBuffer() call in AcquireCanvasForRaster().
+    bool content_has_changed =
+        resource_provider()->UnmapPixelRasterBuffer(state.resource->id());
+
+    // |content_has_changed| can be false as result of task being canceled or
+    // task implementation deciding not to modify bitmap (ie. analysis of raster
+    // commands detected content as a solid color).
+    if (!content_has_changed) {
+      task->WillComplete();
+      task->CompleteOnOriginThread(this);
+      task->DidComplete();
+
+      if (!task->HasFinishedRunning()) {
+        // When priorites change, a raster task can be canceled as a result of
+        // no longer being of high enough priority to fit in our throttled
+        // raster task budget. The task has not yet completed in this case.
+        for (RasterTaskQueue::Item::Vector::const_iterator it =
+                 raster_tasks_.items.begin();
+             it != raster_tasks_.items.end();
+             ++it) {
+          if (it->task == task) {
+            state.type = RasterTaskState::UNSCHEDULED;
+            state.resource = NULL;
+            continue;
+          }
+        }
+      }
+
+      DCHECK(std::find(completed_raster_tasks_.begin(),
+                       completed_raster_tasks_.end(),
+                       task) == completed_raster_tasks_.end());
+      completed_raster_tasks_.push_back(task);
+      state.type = RasterTaskState::COMPLETED;
+      raster_tasks_required_for_activation_.erase(task);
+      continue;
+    }
+
+    DCHECK(task->HasFinishedRunning());
+
+    resource_provider()->BeginSetPixels(state.resource->id());
+    has_performed_uploads_since_last_flush_ = true;
+
+    bytes_pending_upload_ += state.resource->bytes();
+    raster_tasks_with_pending_upload_.push_back(task);
+    state.type = RasterTaskState::UPLOADING;
   }
   completed_tasks_.clear();
 }
 
 bool PixelBufferRasterWorkerPool::IsRasterTaskRequiredForActivation(
-    internal::RasterWorkerPoolTask* task) const {
+    internal::WorkerPoolTask* task) const {
   return raster_tasks_required_for_activation_.find(task) !=
          raster_tasks_required_for_activation_.end();
 }
 
 scoped_ptr<base::Value> PixelBufferRasterWorkerPool::StateAsValue() const {
   scoped_ptr<base::DictionaryValue> state(new base::DictionaryValue);
 
   state->SetInteger("completed_count", completed_raster_tasks_.size());
   state->SetInteger("pending_count", raster_task_states_.size());
   state->SetInteger("pending_upload_count",
@@ skipping 10 matching lines @@
 
   throttle_state->SetInteger("bytes_available_for_upload",
                              max_bytes_pending_upload_ - bytes_pending_upload_);
   throttle_state->SetInteger("bytes_pending_upload", bytes_pending_upload_);
   throttle_state->SetInteger("scheduled_raster_task_count",
                              scheduled_raster_task_count_);
   return throttle_state.PassAs<base::Value>();
 }
 
 }  // namespace cc