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