cc/resources/one_copy_tile_task_worker_pool.cc

   1 // Copyright 2014 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 #include "cc/resources/one_copy_tile_task_worker_pool.h"
   6
   7 #include <algorithm>
   8 #include <limits>
   9
  10 #include "base/debug/trace_event.h"
  11 #include "base/debug/trace_event_argument.h"
  12 #include "base/strings/stringprintf.h"
  13 #include "cc/debug/traced_value.h"
  14 #include "cc/resources/raster_buffer.h"
  15 #include "cc/resources/resource_pool.h"
  16 #include "cc/resources/scoped_resource.h"
  17 #include "gpu/command_buffer/client/gles2_interface.h"
  18 #include "ui/gfx/gpu_memory_buffer.h"
  19
  20 namespace cc {
  21 namespace {
  22
  23 class RasterBufferImpl : public RasterBuffer {
  24  public:
  25   RasterBufferImpl(OneCopyTileTaskWorkerPool* worker_pool,
  26                    ResourceProvider* resource_provider,
  27                    ResourcePool* resource_pool,
  28                    const Resource* resource)
  29       : worker_pool_(worker_pool),
  30         resource_provider_(resource_provider),
  31         resource_pool_(resource_pool),
  32         resource_(resource),
  33         raster_resource_(
  34             resource_pool->AcquireResource(resource->size(),
  35                                            resource_pool->default_format())),
  36         lock_(new ResourceProvider::ScopedWriteLockGpuMemoryBuffer(
  37             resource_provider_,
  38             raster_resource_->id())),
  39         sequence_(0) {}
  40
  41   ~RasterBufferImpl() override {
  42     // Release write lock in case a copy was never scheduled.
  43     lock_.reset();
  44
  45     // Make sure any scheduled copy operations are issued before we release the
  46     // raster resource.
  47     if (sequence_)
  48       worker_pool_->AdvanceLastIssuedCopyTo(sequence_);
  49
  50     // Return raster resource to pool so it can be used by another RasterBuffer
  51     // instance.
  52     if (raster_resource_)
  53       resource_pool_->ReleaseResource(raster_resource_.Pass());
  54   }
  55
  56   // Overridden from RasterBuffer:
  57   void Playback(const RasterSource* raster_source,
  58                 const gfx::Rect& rect,
  59                 float scale) override {
  60     sequence_ = worker_pool_->PlaybackAndScheduleCopyOnWorkerThread(
  61         lock_.Pass(), raster_resource_.Pass(), resource_, raster_source, rect,
  62         scale);
  63   }
  64
  65  private:
  66   OneCopyTileTaskWorkerPool* worker_pool_;
  67   ResourceProvider* resource_provider_;
  68   ResourcePool* resource_pool_;
  69   const Resource* resource_;
  70   scoped_ptr<ScopedResource> raster_resource_;
  71   scoped_ptr<ResourceProvider::ScopedWriteLockGpuMemoryBuffer> lock_;
  72   CopySequenceNumber sequence_;
  73
  74   DISALLOW_COPY_AND_ASSIGN(RasterBufferImpl);
  75 };
  76
  77 // Flush interval when performing copy operations.
  78 const int kCopyFlushPeriod = 4;
  79
  80 // Number of in-flight copy operations to allow.
  81 const int kMaxCopyOperations = 16;
  82
  83 // Delay been checking for copy operations to complete.
  84 const int kCheckForCompletedCopyOperationsTickRateMs = 1;
  85
  86 // Number of failed attempts to allow before we perform a check that will
  87 // wait for copy operations to complete if needed.
  88 const int kFailedAttemptsBeforeWaitIfNeeded = 256;
  89
  90 }  // namespace
  91
  92 OneCopyTileTaskWorkerPool::CopyOperation::CopyOperation(
  93     scoped_ptr<ResourceProvider::ScopedWriteLockGpuMemoryBuffer> write_lock,
  94     scoped_ptr<ScopedResource> src,
  95     const Resource* dst)
  96     : write_lock(write_lock.Pass()), src(src.Pass()), dst(dst) {
  97 }
  98
  99 OneCopyTileTaskWorkerPool::CopyOperation::~CopyOperation() {
 100 }
 101
 102 // static
 103 scoped_ptr<TileTaskWorkerPool> OneCopyTileTaskWorkerPool::Create(
 104     base::SequencedTaskRunner* task_runner,
 105     TaskGraphRunner* task_graph_runner,
 106     ContextProvider* context_provider,
 107     ResourceProvider* resource_provider,
 108     ResourcePool* resource_pool) {
 109   return make_scoped_ptr<TileTaskWorkerPool>(new OneCopyTileTaskWorkerPool(
 110       task_runner, task_graph_runner, context_provider, resource_provider,
 111       resource_pool));
 112 }
 113
 114 OneCopyTileTaskWorkerPool::OneCopyTileTaskWorkerPool(
 115     base::SequencedTaskRunner* task_runner,
 116     TaskGraphRunner* task_graph_runner,
 117     ContextProvider* context_provider,
 118     ResourceProvider* resource_provider,
 119     ResourcePool* resource_pool)
 120     : task_runner_(task_runner),
 121       task_graph_runner_(task_graph_runner),
 122       namespace_token_(task_graph_runner->GetNamespaceToken()),
 123       context_provider_(context_provider),
 124       resource_provider_(resource_provider),
 125       resource_pool_(resource_pool),
 126       last_issued_copy_operation_(0),
 127       last_flushed_copy_operation_(0),
 128       lock_(),
 129       copy_operation_count_cv_(&lock_),
 130       scheduled_copy_operation_count_(0),
 131       issued_copy_operation_count_(0),
 132       next_copy_operation_sequence_(1),
 133       check_for_completed_copy_operations_pending_(false),
 134       shutdown_(false),
 135       weak_ptr_factory_(this),
 136       task_set_finished_weak_ptr_factory_(this) {
 137   DCHECK(context_provider_);
 138 }
 139
 140 OneCopyTileTaskWorkerPool::~OneCopyTileTaskWorkerPool() {
 141   DCHECK_EQ(scheduled_copy_operation_count_, 0u);
 142 }
 143
 144 TileTaskRunner* OneCopyTileTaskWorkerPool::AsTileTaskRunner() {
 145   return this;
 146 }
 147
 148 void OneCopyTileTaskWorkerPool::SetClient(TileTaskRunnerClient* client) {
 149   client_ = client;
 150 }
 151
 152 void OneCopyTileTaskWorkerPool::Shutdown() {
 153   TRACE_EVENT0("cc", "OneCopyTileTaskWorkerPool::Shutdown");
 154
 155   {
 156     base::AutoLock lock(lock_);
 157
 158     shutdown_ = true;
 159     copy_operation_count_cv_.Signal();
 160   }
 161
 162   TaskGraph empty;
 163   task_graph_runner_->ScheduleTasks(namespace_token_, &empty);
 164   task_graph_runner_->WaitForTasksToFinishRunning(namespace_token_);
 165 }
 166
 167 void OneCopyTileTaskWorkerPool::ScheduleTasks(TileTaskQueue* queue) {
 168   TRACE_EVENT0("cc", "OneCopyTileTaskWorkerPool::ScheduleTasks");
 169
 170   if (tasks_pending_.none())
 171     TRACE_EVENT_ASYNC_BEGIN0("cc", "ScheduledTasks", this);
 172
 173   // Mark all task sets as pending.
 174   tasks_pending_.set();
 175
 176   unsigned priority = kTileTaskPriorityBase;
 177
 178   graph_.Reset();
 179
 180   // Cancel existing OnTaskSetFinished callbacks.
 181   task_set_finished_weak_ptr_factory_.InvalidateWeakPtrs();
 182
 183   scoped_refptr<TileTask> new_task_set_finished_tasks[kNumberOfTaskSets];
 184
 185   size_t task_count[kNumberOfTaskSets] = {0};
 186
 187   for (TaskSet task_set = 0; task_set < kNumberOfTaskSets; ++task_set) {
 188     new_task_set_finished_tasks[task_set] = CreateTaskSetFinishedTask(
 189         task_runner_.get(),
 190         base::Bind(&OneCopyTileTaskWorkerPool::OnTaskSetFinished,
 191                    task_set_finished_weak_ptr_factory_.GetWeakPtr(), task_set));
 192   }
 193
 194   resource_pool_->CheckBusyResources(false);
 195
 196   for (TileTaskQueue::Item::Vector::const_iterator it = queue->items.begin();
 197        it != queue->items.end(); ++it) {
 198     const TileTaskQueue::Item& item = *it;
 199     RasterTask* task = item.task;
 200     DCHECK(!task->HasCompleted());
 201
 202     for (TaskSet task_set = 0; task_set < kNumberOfTaskSets; ++task_set) {
 203       if (!item.task_sets[task_set])
 204         continue;
 205
 206       ++task_count[task_set];
 207
 208       graph_.edges.push_back(
 209           TaskGraph::Edge(task, new_task_set_finished_tasks[task_set].get()));
 210     }
 211
 212     InsertNodesForRasterTask(&graph_, task, task->dependencies(), priority++);
 213   }
 214
 215   for (TaskSet task_set = 0; task_set < kNumberOfTaskSets; ++task_set) {
 216     InsertNodeForTask(&graph_, new_task_set_finished_tasks[task_set].get(),
 217                       kTaskSetFinishedTaskPriority, task_count[task_set]);
 218   }
 219
 220   ScheduleTasksOnOriginThread(this, &graph_);
 221   task_graph_runner_->ScheduleTasks(namespace_token_, &graph_);
 222
 223   std::copy(new_task_set_finished_tasks,
 224             new_task_set_finished_tasks + kNumberOfTaskSets,
 225             task_set_finished_tasks_);
 226
 227   resource_pool_->ReduceResourceUsage();
 228
 229   TRACE_EVENT_ASYNC_STEP_INTO1("cc", "ScheduledTasks", this, "running", "state",
 230                                StateAsValue());
 231 }
 232
 233 void OneCopyTileTaskWorkerPool::CheckForCompletedTasks() {
 234   TRACE_EVENT0("cc", "OneCopyTileTaskWorkerPool::CheckForCompletedTasks");
 235
 236   task_graph_runner_->CollectCompletedTasks(namespace_token_,
 237                                             &completed_tasks_);
 238
 239   for (Task::Vector::const_iterator it = completed_tasks_.begin();
 240        it != completed_tasks_.end(); ++it) {
 241     TileTask* task = static_cast<TileTask*>(it->get());
 242
 243     task->WillComplete();
 244     task->CompleteOnOriginThread(this);
 245     task->DidComplete();
 246
 247     task->RunReplyOnOriginThread();
 248   }
 249   completed_tasks_.clear();
 250 }
 251
 252 scoped_ptr<RasterBuffer> OneCopyTileTaskWorkerPool::AcquireBufferForRaster(
 253     const Resource* resource) {
 254   DCHECK_EQ(resource->format(), resource_pool_->default_format());
 255   return make_scoped_ptr<RasterBuffer>(
 256       new RasterBufferImpl(this, resource_provider_, resource_pool_, resource));
 257 }
 258
 259 void OneCopyTileTaskWorkerPool::ReleaseBufferForRaster(
 260     scoped_ptr<RasterBuffer> buffer) {
 261   // Nothing to do here. RasterBufferImpl destructor cleans up after itself.
 262 }
 263
 264 CopySequenceNumber
 265 OneCopyTileTaskWorkerPool::PlaybackAndScheduleCopyOnWorkerThread(
 266     scoped_ptr<ResourceProvider::ScopedWriteLockGpuMemoryBuffer> write_lock,
 267     scoped_ptr<ScopedResource> src,
 268     const Resource* dst,
 269     const RasterSource* raster_source,
 270     const gfx::Rect& rect,
 271     float scale) {
 272   base::AutoLock lock(lock_);
 273
 274   int failed_attempts = 0;
 275   while ((scheduled_copy_operation_count_ + issued_copy_operation_count_) >=
 276          kMaxCopyOperations) {
 277     // Ignore limit when shutdown is set.
 278     if (shutdown_)
 279       break;
 280
 281     ++failed_attempts;
 282
 283     // Schedule a check that will also wait for operations to complete
 284     // after too many failed attempts.
 285     bool wait_if_needed = failed_attempts > kFailedAttemptsBeforeWaitIfNeeded;
 286
 287     // Schedule a check for completed copy operations if too many operations
 288     // are currently in-flight.
 289     ScheduleCheckForCompletedCopyOperationsWithLockAcquired(wait_if_needed);
 290
 291     {
 292       TRACE_EVENT0("cc", "WaitingForCopyOperationsToComplete");
 293
 294       // Wait for in-flight copy operations to drop below limit.
 295       copy_operation_count_cv_.Wait();
 296     }
 297   }
 298
 299   // Increment |scheduled_copy_operation_count_| before releasing |lock_|.
 300   ++scheduled_copy_operation_count_;
 301
 302   // There may be more work available, so wake up another worker thread.
 303   copy_operation_count_cv_.Signal();
 304
 305   {
 306     base::AutoUnlock unlock(lock_);
 307
 308     gfx::GpuMemoryBuffer* gpu_memory_buffer = write_lock->GetGpuMemoryBuffer();
 309     if (gpu_memory_buffer) {
 310       TileTaskWorkerPool::PlaybackToMemory(
 311           gpu_memory_buffer->Map(), src->format(), src->size(),
 312           gpu_memory_buffer->GetStride(), raster_source, rect, scale);
 313       gpu_memory_buffer->Unmap();
 314     }
 315   }
 316
 317   pending_copy_operations_.push_back(
 318       make_scoped_ptr(new CopyOperation(write_lock.Pass(), src.Pass(), dst)));
 319
 320   // Acquire a sequence number for this copy operation.
 321   CopySequenceNumber sequence = next_copy_operation_sequence_++;
 322
 323   // Post task that will advance last flushed copy operation to |sequence|
 324   // if we have reached the flush period.
 325   if ((sequence % kCopyFlushPeriod) == 0) {
 326     task_runner_->PostTask(
 327         FROM_HERE,
 328         base::Bind(&OneCopyTileTaskWorkerPool::AdvanceLastFlushedCopyTo,
 329                    weak_ptr_factory_.GetWeakPtr(), sequence));
 330   }
 331
 332   return sequence;
 333 }
 334
 335 void OneCopyTileTaskWorkerPool::AdvanceLastIssuedCopyTo(
 336     CopySequenceNumber sequence) {
 337   if (last_issued_copy_operation_ >= sequence)
 338     return;
 339
 340   IssueCopyOperations(sequence - last_issued_copy_operation_);
 341   last_issued_copy_operation_ = sequence;
 342 }
 343
 344 void OneCopyTileTaskWorkerPool::AdvanceLastFlushedCopyTo(
 345     CopySequenceNumber sequence) {
 346   if (last_flushed_copy_operation_ >= sequence)
 347     return;
 348
 349   AdvanceLastIssuedCopyTo(sequence);
 350
 351   // Flush all issued copy operations.
 352   context_provider_->ContextGL()->ShallowFlushCHROMIUM();
 353   last_flushed_copy_operation_ = last_issued_copy_operation_;
 354 }
 355
 356 void OneCopyTileTaskWorkerPool::OnTaskSetFinished(TaskSet task_set) {
 357   TRACE_EVENT1("cc", "OneCopyTileTaskWorkerPool::OnTaskSetFinished", "task_set",
 358                task_set);
 359
 360   DCHECK(tasks_pending_[task_set]);
 361   tasks_pending_[task_set] = false;
 362   if (tasks_pending_.any()) {
 363     TRACE_EVENT_ASYNC_STEP_INTO1("cc", "ScheduledTasks", this, "running",
 364                                  "state", StateAsValue());
 365   } else {
 366     TRACE_EVENT_ASYNC_END0("cc", "ScheduledTasks", this);
 367   }
 368   client_->DidFinishRunningTileTasks(task_set);
 369 }
 370
 371 void OneCopyTileTaskWorkerPool::IssueCopyOperations(int64 count) {
 372   TRACE_EVENT1("cc", "OneCopyTileTaskWorkerPool::IssueCopyOperations", "count",
 373                count);
 374
 375   CopyOperation::Deque copy_operations;
 376
 377   {
 378     base::AutoLock lock(lock_);
 379
 380     for (int64 i = 0; i < count; ++i) {
 381       DCHECK(!pending_copy_operations_.empty());
 382       copy_operations.push_back(pending_copy_operations_.take_front());
 383     }
 384
 385     // Decrement |scheduled_copy_operation_count_| and increment
 386     // |issued_copy_operation_count_| to reflect the transition of copy
 387     // operations from "pending" to "issued" state.
 388     DCHECK_GE(scheduled_copy_operation_count_, copy_operations.size());
 389     scheduled_copy_operation_count_ -= copy_operations.size();
 390     issued_copy_operation_count_ += copy_operations.size();
 391   }
 392
 393   while (!copy_operations.empty()) {
 394     scoped_ptr<CopyOperation> copy_operation = copy_operations.take_front();
 395
 396     // Remove the write lock.
 397     copy_operation->write_lock.reset();
 398
 399     // Copy contents of source resource to destination resource.
 400     resource_provider_->CopyResource(copy_operation->src->id(),
 401                                      copy_operation->dst->id());
 402
 403     // Return source resource to pool where it can be reused once copy
 404     // operation has completed and resource is no longer busy.
 405     resource_pool_->ReleaseResource(copy_operation->src.Pass());
 406   }
 407 }
 408
 409 void OneCopyTileTaskWorkerPool::
 410     ScheduleCheckForCompletedCopyOperationsWithLockAcquired(
 411         bool wait_if_needed) {
 412   lock_.AssertAcquired();
 413
 414   if (check_for_completed_copy_operations_pending_)
 415     return;
 416
 417   base::TimeTicks now = base::TimeTicks::Now();
 418
 419   // Schedule a check for completed copy operations as soon as possible but
 420   // don't allow two consecutive checks to be scheduled to run less than the
 421   // tick rate apart.
 422   base::TimeTicks next_check_for_completed_copy_operations_time =
 423       std::max(last_check_for_completed_copy_operations_time_ +
 424                    base::TimeDelta::FromMilliseconds(
 425                        kCheckForCompletedCopyOperationsTickRateMs),
 426                now);
 427
 428   task_runner_->PostDelayedTask(
 429       FROM_HERE,
 430       base::Bind(&OneCopyTileTaskWorkerPool::CheckForCompletedCopyOperations,
 431                  weak_ptr_factory_.GetWeakPtr(), wait_if_needed),
 432       next_check_for_completed_copy_operations_time - now);
 433
 434   last_check_for_completed_copy_operations_time_ =
 435       next_check_for_completed_copy_operations_time;
 436   check_for_completed_copy_operations_pending_ = true;
 437 }
 438
 439 void OneCopyTileTaskWorkerPool::CheckForCompletedCopyOperations(
 440     bool wait_if_needed) {
 441   TRACE_EVENT1("cc",
 442                "OneCopyTileTaskWorkerPool::CheckForCompletedCopyOperations",
 443                "wait_if_needed", wait_if_needed);
 444
 445   resource_pool_->CheckBusyResources(wait_if_needed);
 446
 447   {
 448     base::AutoLock lock(lock_);
 449
 450     DCHECK(check_for_completed_copy_operations_pending_);
 451     check_for_completed_copy_operations_pending_ = false;
 452
 453     // The number of busy resources in the pool reflects the number of issued
 454     // copy operations that have not yet completed.
 455     issued_copy_operation_count_ = resource_pool_->busy_resource_count();
 456
 457     // There may be work blocked on too many in-flight copy operations, so wake
 458     // up a worker thread.
 459     copy_operation_count_cv_.Signal();
 460   }
 461 }
 462
 463 scoped_refptr<base::debug::ConvertableToTraceFormat>
 464 OneCopyTileTaskWorkerPool::StateAsValue() const {
 465   scoped_refptr<base::debug::TracedValue> state =
 466       new base::debug::TracedValue();
 467
 468   state->BeginArray("tasks_pending");
 469   for (TaskSet task_set = 0; task_set < kNumberOfTaskSets; ++task_set)
 470     state->AppendBoolean(tasks_pending_[task_set]);
 471   state->EndArray();
 472   state->BeginDictionary("staging_state");
 473   StagingStateAsValueInto(state.get());
 474   state->EndDictionary();
 475
 476   return state;
 477 }
 478
 479 void OneCopyTileTaskWorkerPool::StagingStateAsValueInto(
 480     base::debug::TracedValue* staging_state) const {
 481   staging_state->SetInteger("staging_resource_count",
 482                             resource_pool_->total_resource_count());
 483   staging_state->SetInteger("bytes_used_for_staging_resources",
 484                             resource_pool_->total_memory_usage_bytes());
 485   staging_state->SetInteger("pending_copy_count",
 486                             resource_pool_->total_resource_count() -
 487                                 resource_pool_->acquired_resource_count());
 488   staging_state->SetInteger("bytes_pending_copy",
 489                             resource_pool_->total_memory_usage_bytes() -
 490                                 resource_pool_->acquired_memory_usage_bytes());
 491 }
 492
 493 }  // namespace cc