cc: Measure compositor timing with finer granularity

cc/scheduler/scheduler.h

 // Copyright 2011 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.
 
 #ifndef CC_SCHEDULER_SCHEDULER_H_
 #define CC_SCHEDULER_SCHEDULER_H_
 
 #include <deque>
 #include <string>
 
 #include "base/basictypes.h"
 #include "base/cancelable_callback.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/time/time.h"
 #include "cc/base/cc_export.h"
 #include "cc/output/begin_frame_args.h"
 #include "cc/output/vsync_parameter_observer.h"
 #include "cc/scheduler/begin_frame_source.h"
 #include "cc/scheduler/begin_frame_tracker.h"
+#include "cc/scheduler/compositor_timing_history.h"
 #include "cc/scheduler/delay_based_time_source.h"
 #include "cc/scheduler/draw_result.h"
 #include "cc/scheduler/scheduler_settings.h"
 #include "cc/scheduler/scheduler_state_machine.h"
 
 namespace base {
 namespace trace_event {
 class ConvertableToTraceFormat;
 }
 class SingleThreadTaskRunner;
 }
 
 namespace cc {
 
+class RenderingStatsInstrumentation;
+
 class SchedulerClient {
  public:
   virtual void WillBeginImplFrame(const BeginFrameArgs& args) = 0;
   virtual void ScheduledActionSendBeginMainFrame() = 0;
   virtual DrawResult ScheduledActionDrawAndSwapIfPossible() = 0;
   virtual DrawResult ScheduledActionDrawAndSwapForced() = 0;
   virtual void ScheduledActionAnimate() = 0;
   virtual void ScheduledActionCommit() = 0;
   virtual void ScheduledActionActivateSyncTree() = 0;
   virtual void ScheduledActionBeginOutputSurfaceCreation() = 0;
   virtual void ScheduledActionPrepareTiles() = 0;
   virtual void ScheduledActionInvalidateOutputSurface() = 0;
   virtual void DidAnticipatedDrawTimeChange(base::TimeTicks time) = 0;
-  virtual base::TimeDelta DrawDurationEstimate() = 0;
-  virtual base::TimeDelta BeginMainFrameToCommitDurationEstimate() = 0;
-  virtual base::TimeDelta CommitToActivateDurationEstimate() = 0;
   virtual void DidFinishImplFrame() = 0;
   virtual void SendBeginFramesToChildren(const BeginFrameArgs& args) = 0;
   virtual void SendBeginMainFrameNotExpectedSoon() = 0;
 
  protected:
   virtual ~SchedulerClient() {}
 };
 
 class Scheduler;
 // This class exists to allow tests to override the frame source construction.
@@ skipping 13 matching lines @@
   friend class Scheduler;
 };
 
 class CC_EXPORT Scheduler : public BeginFrameObserverBase {
  public:
   static scoped_ptr<Scheduler> Create(
       SchedulerClient* client,
       const SchedulerSettings& scheduler_settings,
       int layer_tree_host_id,
       const scoped_refptr<base::SingleThreadTaskRunner>& task_runner,
-      scoped_ptr<BeginFrameSource> external_begin_frame_source) {
+      scoped_ptr<BeginFrameSource> external_begin_frame_source,
+      RenderingStatsInstrumentation* rendering_stats_instrumentation) {
     SchedulerFrameSourcesConstructor frame_sources_constructor;
-    return make_scoped_ptr(new Scheduler(client,
-                                         scheduler_settings,
-                                         layer_tree_host_id,
-                                         task_runner,
-                                         external_begin_frame_source.Pass(),
-                                         &frame_sources_constructor));
+    return make_scoped_ptr(new Scheduler(
+        client, scheduler_settings, layer_tree_host_id, task_runner,
+        external_begin_frame_source.Pass(), rendering_stats_instrumentation,
+        &frame_sources_constructor));
   }
 
   ~Scheduler() override;
 
   // BeginFrameObserverBase
   bool OnBeginFrameDerivedImpl(const BeginFrameArgs& args) override;
 
   void OnDrawForOutputSurface();
 
   const SchedulerSettings& settings() const { return settings_; }
@@ skipping 21 matching lines @@
   void SetWaitForReadyToDraw();
 
   void SetMaxSwapsPending(int max);
   void DidSwapBuffers();
   void DidSwapBuffersComplete();
 
   void SetImplLatencyTakesPriority(bool impl_latency_takes_priority);
 
   void NotifyReadyToCommit();
   void BeginMainFrameAborted(CommitEarlyOutReason reason);
+  void DidCommit();
 
+  void WillPrepareTiles();
   void DidPrepareTiles();
   void DidLoseOutputSurface();
   void DidCreateAndInitializeOutputSurface();
 
   // Tests do not want to shut down until all possible BeginMainFrames have
   // occured to prevent flakiness.
   bool MainFrameForTestingWillHappen() const {
     return state_machine_.CommitPending() ||
            state_machine_.CouldSendBeginMainFrame();
   }
@@ skipping 32 matching lines @@
   void SetVideoNeedsBeginFrames(bool video_needs_begin_frames);
 
   void SetAuthoritativeVSyncInterval(const base::TimeDelta& interval);
 
  protected:
   Scheduler(SchedulerClient* client,
             const SchedulerSettings& scheduler_settings,
             int layer_tree_host_id,
             const scoped_refptr<base::SingleThreadTaskRunner>& task_runner,
             scoped_ptr<BeginFrameSource> external_begin_frame_source,
+            RenderingStatsInstrumentation* rendering_stats_instrumentation,
             SchedulerFrameSourcesConstructor* frame_sources_constructor);
 
   // virtual for testing - Don't call these in the constructor or
   // destructor!
   virtual base::TimeTicks Now() const;
+  virtual base::TimeDelta BeginMainFrameToCommitDurationEstimate() const;
+  virtual base::TimeDelta PrepareTilesDurationEstimate() const;
+  virtual base::TimeDelta PrepareTilesToReadyToActivateDurationEstimate() const;
+  virtual base::TimeDelta ActivateDurationEstimate() const;
+  virtual base::TimeDelta DrawDurationEstimate() const;
 
   scoped_ptr<BeginFrameSourceMultiplexer> frame_source_;
   BeginFrameSource* primary_frame_source_;
   BeginFrameSource* unthrottled_frame_source_;
 
   // Storage when frame sources are internal
   scoped_ptr<BeginFrameSource> primary_frame_source_internal_;
   scoped_ptr<BeginFrameSource> unthrottled_frame_source_internal_;
 
   VSyncParameterObserver* vsync_observer_;
   base::TimeDelta authoritative_vsync_interval_;
   base::TimeTicks last_vsync_timebase_;
 
   bool throttle_frame_production_;
 
   const SchedulerSettings settings_;
   SchedulerClient* client_;
   int layer_tree_host_id_;
   scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
 
+  CompositorTimingHistory compositor_timing_history_;
   base::TimeDelta estimated_parent_draw_time_;
 
   std::deque<BeginFrameArgs> begin_retro_frame_args_;
   SchedulerStateMachine::BeginImplFrameDeadlineMode
       begin_impl_frame_deadline_mode_;
   BeginFrameTracker begin_impl_frame_tracker_;
 
   base::Closure begin_retro_frame_closure_;
   base::Closure begin_impl_frame_deadline_closure_;
   base::Closure advance_commit_state_closure_;
   base::CancelableClosure begin_retro_frame_task_;
   base::CancelableClosure begin_impl_frame_deadline_task_;
   base::CancelableClosure advance_commit_state_task_;
 
   SchedulerStateMachine state_machine_;
   bool inside_process_scheduled_actions_;
   SchedulerStateMachine::Action inside_action_;
 
  private:
   void ScheduleBeginImplFrameDeadline();
   void ScheduleBeginImplFrameDeadlineIfNeeded();
   void SetupNextBeginFrameIfNeeded();
   void PostBeginRetroFrameIfNeeded();
   void SetupPollingMechanisms();
   void DrawAndSwapIfPossible();
+  void DrawAndSwapForced();
   void ProcessScheduledActions();
   bool CanCommitAndActivateBeforeDeadline() const;
   void AdvanceCommitStateIfPossible();
   bool IsBeginMainFrameSentOrStarted() const;
   void BeginRetroFrame();
   void BeginImplFrameWithDeadline(const BeginFrameArgs& args);
   void BeginImplFrameSynchronous(const BeginFrameArgs& args);
   void BeginImplFrame(const BeginFrameArgs& args);
   void FinishImplFrame();
   void OnBeginImplFrameDeadline();
@@ skipping 11 matching lines @@
 
   friend class SchedulerFrameSourcesConstructor;
   friend class TestSchedulerFrameSourcesConstructor;
 
   DISALLOW_COPY_AND_ASSIGN(Scheduler);
 };
 
 }  // namespace cc
 
 #endif  // CC_SCHEDULER_SCHEDULER_H_