cc/debug/frame_timing_tracker.h

   1 // Copyright 2015 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 #ifndef CC_DEBUG_FRAME_TIMING_TRACKER_H_
   6 #define CC_DEBUG_FRAME_TIMING_TRACKER_H_
   7
   8 #include <utility>
   9 #include <vector>
  10
  11 #include "base/basictypes.h"
  12 #include "base/containers/hash_tables.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "base/time/time.h"
  15 #include "cc/base/cc_export.h"
  16 #include "cc/base/delayed_unique_notifier.h"
  17
  18 namespace cc {
  19
  20 class LayerTreeHostImpl;
  21
  22 // This class maintains a history of timestamps and rect IDs to communicate
  23 // frame events back to Blink
  24 // TODO(mpb): Start using this. crbug.com/442554
  25 class CC_EXPORT FrameTimingTracker {
  26  public:
  27   struct CC_EXPORT CompositeTimingEvent {
  28     CompositeTimingEvent(int, base::TimeTicks);
  29     ~CompositeTimingEvent();
  30
  31     int frame_id;
  32     base::TimeTicks timestamp;
  33   };
  34
  35   using CompositeTimingSet =
  36       base::hash_map<int64_t, std::vector<CompositeTimingEvent>>;
  37
  38   struct CC_EXPORT MainFrameTimingEvent {
  39     MainFrameTimingEvent(int frame_id,
  40                          base::TimeTicks timestamp,
  41                          base::TimeTicks end_time);
  42     ~MainFrameTimingEvent();
  43
  44     int frame_id;
  45     base::TimeTicks timestamp;
  46     base::TimeTicks end_time;
  47   };
  48
  49   using MainFrameTimingSet =
  50       base::hash_map<int64_t, std::vector<MainFrameTimingEvent>>;
  51
  52   static scoped_ptr<FrameTimingTracker> Create(
  53       LayerTreeHostImpl* layer_tree_host_impl);
  54
  55   ~FrameTimingTracker();
  56
  57   // This routine takes all of the individual CompositeEvents stored in the
  58   // tracker and collects them by "rect_id", as in the example below.
  59   // [ {f_id1,r_id1,t1}, {f_id2,r_id1,t2}, {f_id3,r_id2,t3} ]
  60   // ====>
  61   // [ {r_id1,<{f_id1,t1},{f_id2,t2}>}, {r_id2,<{f_id3,t3}>} ]
  62   scoped_ptr<CompositeTimingSet> GroupCompositeCountsByRectId();
  63
  64   // This routine takes all of the individual MainFrameEvents stored in the
  65   // tracker and collects them by "rect_id", as in the example below.
  66   scoped_ptr<MainFrameTimingSet> GroupMainFrameCountsByRectId();
  67
  68   // This routine takes a timestamp and an array of frame_id,rect_id pairs
  69   // and generates CompositeTimingEvents (frame_id, timestamp) and adds them to
  70   // internal hash_map keyed on rect_id
  71   using FrameAndRectIds = std::pair<int, int64_t>;
  72   void SaveTimeStamps(base::TimeTicks timestamp,
  73                       const std::vector<FrameAndRectIds>& frame_ids);
  74
  75   void SaveMainFrameTimeStamps(const std::vector<int64_t>& request_ids,
  76                                base::TimeTicks main_frame_time,
  77                                base::TimeTicks end_time,
  78                                int source_frame_number);
  79
  80  private:
  81   explicit FrameTimingTracker(LayerTreeHostImpl* layer_tree_host_impl);
  82
  83   void PostEvents();
  84
  85   scoped_ptr<CompositeTimingSet> composite_events_;
  86   scoped_ptr<MainFrameTimingSet> main_frame_events_;
  87
  88   LayerTreeHostImpl* layer_tree_host_impl_;
  89   DelayedUniqueNotifier post_events_notifier_;
  90
  91   DISALLOW_COPY_AND_ASSIGN(FrameTimingTracker);
  92 };
  93
  94 }  // namespace cc
  95
  96 #endif  // CC_DEBUG_FRAME_TIMING_TRACKER_H_