ui/events/latency_info.h

   1 // Copyright 2013 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 UI_EVENTS_LATENCY_INFO_H_
   6 #define UI_EVENTS_LATENCY_INFO_H_
   7
   8 #include <utility>
   9 #include <vector>
  10
  11 #include "base/basictypes.h"
  12 #include "base/containers/small_map.h"
  13 #include "base/time/time.h"
  14 #include "ui/events/events_base_export.h"
  15
  16 namespace ui {
  17
  18 enum LatencyComponentType {
  19   // ---------------------------BEGIN COMPONENT-------------------------------
  20   // BEGIN COMPONENT is when we show the latency begin in chrome://tracing.
  21   // Timestamp when the input event is sent from RenderWidgetHost to renderer.
  22   INPUT_EVENT_LATENCY_BEGIN_RWH_COMPONENT,
  23   // Timestamp when the input event is received in plugin.
  24   INPUT_EVENT_LATENCY_BEGIN_PLUGIN_COMPONENT,
  25   // Timestamp when a scroll update for the main thread is begun.
  26   INPUT_EVENT_LATENCY_BEGIN_SCROLL_UPDATE_MAIN_COMPONENT,
  27   // ---------------------------NORMAL COMPONENT-------------------------------
  28   // Timestamp when the scroll update gesture event is sent from RWH to
  29   // renderer. In Aura, touch event's LatencyInfo is carried over to the gesture
  30   // event. So gesture event's INPUT_EVENT_LATENCY_RWH_COMPONENT is the
  31   // timestamp when its original touch events is sent from RWH to renderer.
  32   // In non-aura platform, INPUT_EVENT_LATENCY_SCROLL_UPDATE_RWH_COMPONENT
  33   // is the same as INPUT_EVENT_LATENCY_RWH_COMPONENT.
  34   INPUT_EVENT_LATENCY_SCROLL_UPDATE_RWH_COMPONENT,
  35   // The original timestamp of the touch event which converts to scroll update.
  36   INPUT_EVENT_LATENCY_SCROLL_UPDATE_ORIGINAL_COMPONENT,
  37   // Original timestamp for input event (e.g. timestamp from kernel).
  38   INPUT_EVENT_LATENCY_ORIGINAL_COMPONENT,
  39   // Timestamp when the UI event is created.
  40   INPUT_EVENT_LATENCY_UI_COMPONENT,
  41   // This is special component indicating there is rendering scheduled for
  42   // the event associated with this LatencyInfo.
  43   INPUT_EVENT_LATENCY_RENDERING_SCHEDULED_COMPONENT,
  44   // Timestamp when a scroll update is forwarded to the main thread.
  45   INPUT_EVENT_LATENCY_FORWARD_SCROLL_UPDATE_TO_MAIN_COMPONENT,
  46   // Timestamp when the event's ack is received by the RWH.
  47   INPUT_EVENT_LATENCY_ACK_RWH_COMPONENT,
  48   // Frame number when a window snapshot was requested. The snapshot
  49   // is taken when the rendering results actually reach the screen.
  50   WINDOW_SNAPSHOT_FRAME_NUMBER_COMPONENT,
  51   // Frame number for a snapshot requested via
  52   // gpuBenchmarking.beginWindowSnapshotPNG
  53   // TODO(vkuzkokov): remove when patch adding this hits Stable
  54   WINDOW_OLD_SNAPSHOT_FRAME_NUMBER_COMPONENT,
  55   // Timestamp when a tab is requested to be shown.
  56   TAB_SHOW_COMPONENT,
  57   // Timestamp of when the browser process receives a buffer swap notification
  58   // from the renderer.
  59   INPUT_EVENT_BROWSER_RECEIVED_RENDERER_SWAP_COMPONENT,
  60   // Timestamp of when the gpu service began swap buffers, unlike
  61   // INPUT_EVENT_LATENCY_TERMINATED_FRAME_SWAP_COMPONENT which measures after.
  62   INPUT_EVENT_GPU_SWAP_BUFFER_COMPONENT,
  63   // ---------------------------TERMINAL COMPONENT-----------------------------
  64   // TERMINAL COMPONENT is when we show the latency end in chrome://tracing.
  65   // Timestamp when the mouse event is acked from renderer and it does not
  66   // cause any rendering scheduled.
  67   INPUT_EVENT_LATENCY_TERMINATED_MOUSE_COMPONENT,
  68   // Timestamp when the touch event is acked from renderer and it does not
  69   // cause any rendering schedueld and does not generate any gesture event.
  70   INPUT_EVENT_LATENCY_TERMINATED_TOUCH_COMPONENT,
  71   // Timestamp when the gesture event is acked from renderer, and it does not
  72   // cause any rendering schedueld.
  73   INPUT_EVENT_LATENCY_TERMINATED_GESTURE_COMPONENT,
  74   // Timestamp when the frame is swapped (i.e. when the rendering caused by
  75   // input event actually takes effect).
  76   INPUT_EVENT_LATENCY_TERMINATED_FRAME_SWAP_COMPONENT,
  77   // This component indicates that the input causes a commit to be scheduled
  78   // but the commit failed.
  79   INPUT_EVENT_LATENCY_TERMINATED_COMMIT_FAILED_COMPONENT,
  80   // This component indicates that the input causes a commit to be scheduled
  81   // but the commit was aborted since it carried no new information.
  82   INPUT_EVENT_LATENCY_TERMINATED_COMMIT_NO_UPDATE_COMPONENT,
  83   // This component indicates that the input causes a swap to be scheduled
  84   // but the swap failed.
  85   INPUT_EVENT_LATENCY_TERMINATED_SWAP_FAILED_COMPONENT,
  86   // Timestamp when the input event is considered not cause any rendering
  87   // damage in plugin and thus terminated.
  88   INPUT_EVENT_LATENCY_TERMINATED_PLUGIN_COMPONENT,
  89   LATENCY_COMPONENT_TYPE_LAST = INPUT_EVENT_LATENCY_TERMINATED_PLUGIN_COMPONENT
  90 };
  91
  92 struct EVENTS_BASE_EXPORT LatencyInfo {
  93   struct LatencyComponent {
  94     // Nondecreasing number that can be used to determine what events happened
  95     // in the component at the time this struct was sent on to the next
  96     // component.
  97     int64 sequence_number;
  98     // Average time of events that happened in this component.
  99     base::TimeTicks event_time;
 100     // Count of events that happened in this component
 101     uint32 event_count;
 102   };
 103
 104   struct EVENTS_BASE_EXPORT InputCoordinate {
 105     InputCoordinate();
 106     InputCoordinate(float x, float y);
 107
 108     float x;
 109     float y;
 110   };
 111
 112   // Empirically determined constant based on a typical scroll sequence.
 113   enum { kTypicalMaxComponentsPerLatencyInfo = 9 };
 114
 115   enum { kMaxInputCoordinates = 2 };
 116
 117   // Map a Latency Component (with a component-specific int64 id) to a
 118   // component info.
 119   typedef base::SmallMap<
 120       std::map<std::pair<LatencyComponentType, int64>, LatencyComponent>,
 121       kTypicalMaxComponentsPerLatencyInfo> LatencyMap;
 122
 123   LatencyInfo();
 124
 125   ~LatencyInfo();
 126
 127   // Returns true if the vector |latency_info| is valid. Returns false
 128   // if it is not valid and log the |referring_msg|.
 129   // This function is mainly used to check the latency_info vector that
 130   // is passed between processes using IPC message has reasonable size
 131   // so that we are confident the IPC message is not corrupted/compromised.
 132   // This check will go away once the IPC system has better built-in scheme
 133   // for corruption/compromise detection.
 134   static bool Verify(const std::vector<LatencyInfo>& latency_info,
 135                      const char* referring_msg);
 136
 137   // Copy LatencyComponents with type |type| from |other| into |this|.
 138   void CopyLatencyFrom(const LatencyInfo& other, LatencyComponentType type);
 139
 140   // Add LatencyComponents that are in |other| but not in |this|.
 141   void AddNewLatencyFrom(const LatencyInfo& other);
 142
 143   // Modifies the current sequence number for a component, and adds a new
 144   // sequence number with the current timestamp.
 145   void AddLatencyNumber(LatencyComponentType component,
 146                         int64 id,
 147                         int64 component_sequence_number);
 148
 149   // Modifies the current sequence number and adds a certain number of events
 150   // for a specific component.
 151   void AddLatencyNumberWithTimestamp(LatencyComponentType component,
 152                                      int64 id,
 153                                      int64 component_sequence_number,
 154                                      base::TimeTicks time,
 155                                      uint32 event_count);
 156
 157   // Returns true if the a component with |type| and |id| is found in
 158   // the latency_components and the component is stored to |output| if
 159   // |output| is not NULL. Returns false if no such component is found.
 160   bool FindLatency(LatencyComponentType type,
 161                    int64 id,
 162                    LatencyComponent* output) const;
 163
 164   void RemoveLatency(LatencyComponentType type);
 165
 166   void Clear();
 167
 168   // Records the |event_type| in trace buffer as TRACE_EVENT_ASYNC_STEP.
 169   void TraceEventType(const char* event_type);
 170
 171   LatencyMap latency_components;
 172
 173   // These coordinates represent window coordinates of the original input event.
 174   uint32 input_coordinates_size;
 175   InputCoordinate input_coordinates[kMaxInputCoordinates];
 176
 177   // The unique id for matching the ASYNC_BEGIN/END trace event.
 178   int64 trace_id;
 179   // Whether a terminal component has been added.
 180   bool terminated;
 181 };
 182
 183 }  // namespace ui
 184
 185 #endif  // UI_EVENTS_LATENCY_INFO_H_