scheduler: Add support for tracing scheduler state

content/renderer/scheduler/renderer_scheduler_impl.cc

 // Copyright 2014 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 "content/renderer/scheduler/renderer_scheduler_impl.h"
 
 #include "base/bind.h"
+#include "base/debug/trace_event.h"
+#include "base/debug/trace_event_argument.h"
 #include "base/message_loop/message_loop_proxy.h"
 #include "cc/output/begin_frame_args.h"
 #include "content/renderer/scheduler/renderer_task_queue_selector.h"
 #include "ui/gfx/frame_time.h"
 
 namespace content {
 
 RendererSchedulerImpl::RendererSchedulerImpl()
     : RendererSchedulerImpl(base::MessageLoopProxy::current()) {
 }
@@ skipping 15 matching lines @@
       policy_may_need_update_(0),
       weak_factory_(this) {
   weak_renderer_scheduler_ptr_ = weak_factory_.GetWeakPtr();
   idle_task_runner_ = make_scoped_refptr(new SingleThreadIdleTaskRunner(
       task_queue_manager_->TaskRunnerForQueue(IDLE_TASK_QUEUE),
       weak_factory_.GetWeakPtr()));
   renderer_task_queue_selector_->SetQueuePriority(
       CONTROL_TASK_QUEUE, RendererTaskQueueSelector::CONTROL_PRIORITY);
   renderer_task_queue_selector_->DisableQueue(IDLE_TASK_QUEUE);
   task_queue_manager_->SetAutoPump(IDLE_TASK_QUEUE, false);
+
+  for (size_t i = 0; i < TASK_QUEUE_COUNT; i++) {
+    task_queue_manager_->SetQueueName(
+        i, TaskQueueIdToString(static_cast<QueueId>(i)));
+  }
+  TRACE_EVENT_OBJECT_CREATED_WITH_ID(
+      TRACE_DISABLED_BY_DEFAULT("renderer.scheduler"),
+      "RendererScheduler",
+      this);
 }
 
 RendererSchedulerImpl::~RendererSchedulerImpl() {
 }
 
 void RendererSchedulerImpl::Shutdown() {
   task_queue_manager_.reset();
 }
 
 scoped_refptr<base::SingleThreadTaskRunner>
 RendererSchedulerImpl::DefaultTaskRunner() {
   return default_task_runner_;
 }
 
 scoped_refptr<base::SingleThreadTaskRunner>
 RendererSchedulerImpl::CompositorTaskRunner() {
   return compositor_task_runner_;
 }
 
 scoped_refptr<SingleThreadIdleTaskRunner>
 RendererSchedulerImpl::IdleTaskRunner() {
   return idle_task_runner_;
 }
 
 void RendererSchedulerImpl::WillBeginFrame(const cc::BeginFrameArgs& args) {
+  TRACE_EVENT0(TRACE_DISABLED_BY_DEFAULT("renderer.scheduler"),
+               "RendererSchedulerImpl::WillBeginFrame");

[rmcilroy, 2014/11/07 18:21:57]

Would it be worth passing the args values (frame_time, interval) here?

[Sami, 2014/11/10 14:35:01]

Good idea. Looks like |args| already knows how to serialize itself to the trace.

   main_thread_checker_.CalledOnValidThread();
   if (!task_queue_manager_)
     return;
 
   EndIdlePeriod();
   estimated_next_frame_begin_ = args.frame_time + args.interval;
 }
 
 void RendererSchedulerImpl::DidCommitFrameToCompositor() {
+  TRACE_EVENT0(TRACE_DISABLED_BY_DEFAULT("renderer.scheduler"),
+               "RendererSchedulerImpl::DidCommitFrameToCompositor");
   main_thread_checker_.CalledOnValidThread();
   if (!task_queue_manager_)
     return;
 
   if (Now() < estimated_next_frame_begin_) {
     StartIdlePeriod();
   }
 }
 
 void RendererSchedulerImpl::DidReceiveInputEvent() {
+  TRACE_EVENT0(TRACE_DISABLED_BY_DEFAULT("renderer.scheduler"),
+               "RendererSchedulerImpl::DidReceiveInputEvent");
   if (!task_queue_manager_)
     return;
   base::AutoLock lock(incoming_signals_lock_);
   if (last_input_time_.is_null()) {
     // Update scheduler policy if should start a new compositor policy mode.
     base::subtle::Release_Store(&policy_may_need_update_, 1);
     PostUpdatePolicyOnControlRunner(base::TimeDelta());
   }
   last_input_time_ = Now();
 }
@@ skipping 31 matching lines @@
   }
 }
 
 void RendererSchedulerImpl::UpdatePolicy() {
   main_thread_checker_.CalledOnValidThread();
   if (!task_queue_manager_)
     return;
 
   base::AutoLock lock(incoming_signals_lock_);
   base::subtle::Release_Store(&policy_may_need_update_, 0);
+  base::TimeTicks now;
 
   Policy new_policy = NORMAL_PRIORITY_POLICY;
   if (!last_input_time_.is_null()) {
+    now = Now();
     base::TimeDelta compositor_priority_duration =
         base::TimeDelta::FromMilliseconds(kCompositorPriorityAfterTouchMillis);
     base::TimeDelta remaining_compositor_priority_duration =
-        last_input_time_ + compositor_priority_duration - Now();
+        last_input_time_ + compositor_priority_duration - now;
     if (remaining_compositor_priority_duration > base::TimeDelta()) {
       PostUpdatePolicyOnControlRunner(remaining_compositor_priority_duration);
       new_policy = COMPOSITOR_PRIORITY_POLICY;
     } else {
       // Null out last_input_time_ to ensure DidReceiveInputEvent will post an
       // UpdatePolicy task when it's next called.
       last_input_time_ = base::TimeTicks();
     }
   }
 
   if (new_policy == current_policy_) {
     return;
   }
 
   switch (new_policy) {
     case COMPOSITOR_PRIORITY_POLICY:
       renderer_task_queue_selector_->SetQueuePriority(
           COMPOSITOR_TASK_QUEUE, RendererTaskQueueSelector::HIGH_PRIORITY);
       break;
     case NORMAL_PRIORITY_POLICY:
       renderer_task_queue_selector_->SetQueuePriority(
           COMPOSITOR_TASK_QUEUE, RendererTaskQueueSelector::NORMAL_PRIORITY);
       break;
   }
   current_policy_ = new_policy;
+
+  TRACE_EVENT_OBJECT_SNAPSHOT_WITH_ID(
+      TRACE_DISABLED_BY_DEFAULT("renderer.scheduler"),
+      "RendererScheduler",
+      this,
+      AsValueLocked(now));
+  TRACE_COUNTER1(TRACE_DISABLED_BY_DEFAULT("renderer.scheduler"),
+                 "RendererScheduler.policy",
+                 current_policy_);
 }
 
 void RendererSchedulerImpl::StartIdlePeriod() {
+  TRACE_EVENT_ASYNC_BEGIN0(TRACE_DISABLED_BY_DEFAULT("renderer.scheduler"),
+                           "RendererSchedulerIdlePeriod",
+                           this);
   renderer_task_queue_selector_->EnableQueue(
       IDLE_TASK_QUEUE, RendererTaskQueueSelector::BEST_EFFORT_PRIORITY);
   task_queue_manager_->PumpQueue(IDLE_TASK_QUEUE);
 }
 
 void RendererSchedulerImpl::EndIdlePeriod() {
+  TRACE_EVENT_ASYNC_END0(TRACE_DISABLED_BY_DEFAULT("renderer.scheduler"),
+                         "RendererSchedulerIdlePeriod",
+                         this);
   renderer_task_queue_selector_->DisableQueue(IDLE_TASK_QUEUE);
 }
 
 base::TimeTicks RendererSchedulerImpl::Now() const {
   return gfx::FrameTime::Now();
 }
 
+// static
+const char* RendererSchedulerImpl::TaskQueueIdToString(QueueId queue_id) {
+  switch (queue_id) {
+    case DEFAULT_TASK_QUEUE:
+      return "default_tq";
+    case COMPOSITOR_TASK_QUEUE:
+      return "compositor_tq";
+    case IDLE_TASK_QUEUE:
+      return "idle_tq";
+    case CONTROL_TASK_QUEUE:
+      return "control_tq";
+    default:
+      NOTREACHED();
+      return nullptr;
+  }
+}
+
+// static
+const char* RendererSchedulerImpl::PolicyToString(Policy policy) {
+  switch (policy) {
+    case NORMAL_PRIORITY_POLICY:
+      return "normal";
+    case COMPOSITOR_PRIORITY_POLICY:
+      return "compositor";
+    default:
+      NOTREACHED();
+      return nullptr;
+  }
+}
+
+scoped_refptr<base::debug::ConvertableToTraceFormat>
+RendererSchedulerImpl::AsValueLocked(base::TimeTicks optional_now) const {
+  main_thread_checker_.CalledOnValidThread();
+  incoming_signals_lock_.AssertAcquired();
+
+  if (optional_now.is_null())
+    optional_now = Now();
+  scoped_refptr<base::debug::TracedValue> state =
+      new base::debug::TracedValue();
+
+  state->SetString("current_policy", PolicyToString(current_policy_));
+  state->SetBoolean("has_task_queue_manager", task_queue_manager_.get());
+  state->SetDouble("now", (optional_now - base::TimeTicks()).InMillisecondsF());
+  state->SetDouble("last_input_time",
+                   (last_input_time_ - base::TimeTicks()).InMillisecondsF());
+  state->SetDouble(
+      "estimated_next_frame_begin",
+      (estimated_next_frame_begin_ - base::TimeTicks()).InMillisecondsF());
+
+  return state;
+}
+
 }  // namespace content