cc/benchmarks/benchmark_instrumentation.h

   1 // Copyright 2013 The Chromium Authors
   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_BENCHMARKS_BENCHMARK_INSTRUMENTATION_H_
   6 #define CC_BENCHMARKS_BENCHMARK_INSTRUMENTATION_H_
   7
   8 #include "base/trace_event/trace_event.h"
   9 #include "cc/cc_export.h"
  10 #include "cc/debug/rendering_stats.h"
  11
  12 namespace cc {
  13 namespace benchmark_instrumentation {
  14
  15 // Please do not change the trace events in this file without updating
  16 // tools/perf/measurements/rendering_stats.py accordingly.
  17 // The benchmarks search for events and their arguments by name.
  18
  19 namespace internal {
  20 constexpr const char* Category() {
  21   // Declared as a constexpr function to have an external linkage and to be
  22   // known at compile-time.
  23   return "cc,benchmark";
  24 }
  25 const char kBeginFrameId[] = "begin_frame_id";
  26 }  // namespace internal
  27
  28 const char kSendBeginFrame[] = "ProxyImpl::ScheduledActionSendBeginMainFrame";
  29 const char kDoBeginFrame[] = "ProxyMain::BeginMainFrame";
  30
  31 class ScopedBeginFrameTask {
  32  public:
  33   ScopedBeginFrameTask(const char* event_name, unsigned int begin_frame_id)
  34       : event_name_(event_name) {
  35     TRACE_EVENT_BEGIN1(internal::Category(), event_name_,
  36                        internal::kBeginFrameId, begin_frame_id);
  37   }
  38   ScopedBeginFrameTask(const ScopedBeginFrameTask&) = delete;
  39   ~ScopedBeginFrameTask() {
  40     TRACE_EVENT_END0(internal::Category(), event_name_);
  41   }
  42
  43   ScopedBeginFrameTask& operator=(const ScopedBeginFrameTask&) = delete;
  44
  45  private:
  46   const char* event_name_;
  47 };
  48
  49 void IssueImplThreadRenderingStatsEvent(const RenderingStats& stats);
  50
  51 }  // namespace benchmark_instrumentation
  52 }  // namespace cc
  53
  54 #endif  // CC_BENCHMARKS_BENCHMARK_INSTRUMENTATION_H_