#include <frame_timings.h>

Public Types
enum class	State : uint32_t { kUninitialized , kVsync , kBuildStart , kBuildEnd , kRasterStart , kRasterEnd }

Public Member Functions
	FrameTimingsRecorder ()
	Default constructor, initializes the recorder with State::kUninitialized.

	FrameTimingsRecorder (uint64_t frame_number)
	Constructor with a pre-populated frame number.

	~FrameTimingsRecorder ()

fml::TimePoint	GetVsyncStartTime () const
	Timestamp of the vsync signal.

fml::TimePoint	GetVsyncTargetTime () const

fml::TimePoint	GetBuildStartTime () const
	Timestamp of when the frame building started.

fml::TimePoint	GetBuildEndTime () const
	Timestamp of when the frame was finished building.

fml::TimePoint	GetRasterStartTime () const
	Timestamp of when the frame rasterization started.

fml::TimePoint	GetRasterEndTime () const
	Timestamp of when the frame rasterization finished.

fml::TimePoint	GetRasterEndWallTime () const
	Timestamp of when the frame rasterization is complete in wall-time.

fml::TimeDelta	GetBuildDuration () const
	Duration of the frame build time.

size_t	GetLayerCacheCount () const
	Count of the layer cache entries.

size_t	GetLayerCacheBytes () const
	Total Bytes in all layer cache entries.

size_t	GetPictureCacheCount () const
	Count of the picture cache entries.

size_t	GetPictureCacheBytes () const
	Total Bytes in all picture cache entries.

void	RecordVsync (fml::TimePoint vsync_start, fml::TimePoint vsync_target)
	Records a vsync event.

void	RecordBuildStart (fml::TimePoint build_start)
	Records a build start event.

void	RecordBuildEnd (fml::TimePoint build_end)
	Records a build end event.

void	RecordRasterStart (fml::TimePoint raster_start)
	Records a raster start event.

std::unique_ptr< FrameTimingsRecorder >	CloneUntil (State state)
	Clones the recorder until (and including) the specified state.

FrameTiming	RecordRasterEnd (const RasterCache *cache=nullptr)

uint64_t	GetFrameNumber () const

const char *	GetFrameNumberTraceArg () const
	Returns the frame number in a fml tracing friendly format.

FrameTiming	GetRecordedTime () const
	Returns the recorded time from when `RecordRasterEnd` is called.

void	AssertInState (State state) const

Detailed Description

Records timestamps for various phases of a frame rendering process.

Recorder is created on vsync and destroyed after the rasterization of the frame. This class is thread safe and doesn't require additional synchronization.

Definition at line 30 of file frame_timings.h.

Member Enumeration Documentation

◆ State

enum class flutter::FrameTimingsRecorder::State : uint32_t

strong

Various states that the recorder can be in. When created the recorder is in an unitialized state and transtions in sequential order of the states.

Enumerator
kUninitialized
kVsync
kBuildStart
kBuildEnd
kRasterStart
kRasterEnd

Definition at line 35 of file frame_timings.h.

                   : uint32_t {
    kUninitialized,
    kVsync,
    kBuildStart,
    kBuildEnd,
    kRasterStart,
    kRasterEnd,
  };

Constructor & Destructor Documentation

◆ FrameTimingsRecorder() [1/2]

flutter::FrameTimingsRecorder::FrameTimingsRecorder ( )

Default constructor, initializes the recorder with State::kUninitialized.

Definition at line 43 of file frame_timings.cc.

44 : frame_number_(frame_number_gen_++),

45 frame_number_trace_arg_val_(std::to_string(frame_number_)) {}

◆ FrameTimingsRecorder() [2/2]

flutter::FrameTimingsRecorder::FrameTimingsRecorder ( uint64_t frame_number )

explicit

Constructor with a pre-populated frame number.

Definition at line 47 of file frame_timings.cc.

48 : frame_number_(frame_number),

49 frame_number_trace_arg_val_(std::to_string(frame_number_)) {}

◆ ~FrameTimingsRecorder()

flutter::FrameTimingsRecorder::~FrameTimingsRecorder ( )

default

Member Function Documentation

◆ AssertInState()

void flutter::FrameTimingsRecorder::AssertInState ( State state ) const

Asserts in unopt builds that the recorder is current at the specified state.

Instead of adding a GetState method and asserting on the result, this method prevents other logic from relying on the state.

In release builds, this call is a no-op.

Definition at line 284 of file frame_timings.cc.

                                                          {
  FML_DCHECK(state_ == state) << "Expected state " << StateToString(state)
                              << ", actual state " << StateToString(state_);
}

References FML_DCHECK.

◆ CloneUntil()

std::unique_ptr< FrameTimingsRecorder > flutter::FrameTimingsRecorder::CloneUntil ( State state )

Clones the recorder until (and including) the specified state.

Definition at line 239 of file frame_timings.cc.

                 {
  std::scoped_lock state_lock(state_mutex_);
  std::unique_ptr<FrameTimingsRecorder> recorder =
      std::make_unique<FrameTimingsRecorder>(frame_number_);
  FML_DCHECK(state_ >= state);
  recorder->state_ = state;
 
  if (state >= State::kVsync) {
    recorder->vsync_start_ = vsync_start_;
    recorder->vsync_target_ = vsync_target_;
  }
 
  if (state >= State::kBuildStart) {
    recorder->build_start_ = build_start_;
  }
 
  if (state >= State::kBuildEnd) {
    recorder->build_end_ = build_end_;
  }
 
  if (state >= State::kRasterStart) {
    recorder->raster_start_ = raster_start_;
  }
 
  if (state >= State::kRasterEnd) {
    recorder->raster_end_ = raster_end_;
    recorder->raster_end_wall_time_ = raster_end_wall_time_;
    recorder->layer_cache_count_ = layer_cache_count_;
    recorder->layer_cache_bytes_ = layer_cache_bytes_;
    recorder->picture_cache_count_ = picture_cache_count_;
    recorder->picture_cache_bytes_ = picture_cache_bytes_;
  }
 
  return recorder;
}

References FML_DCHECK, kBuildEnd, kBuildStart, kRasterEnd, kRasterStart, and kVsync.

◆ GetBuildDuration()

fml::TimeDelta flutter::FrameTimingsRecorder::GetBuildDuration ( ) const

Duration of the frame build time.

Definition at line 95 of file frame_timings.cc.

                                                          {
  std::scoped_lock state_lock(state_mutex_);
  FML_DCHECK(state_ >= State::kBuildEnd);
  return build_end_ - build_start_;
}

References FML_DCHECK, and kBuildEnd.

◆ GetBuildEndTime()

fml::TimePoint flutter::FrameTimingsRecorder::GetBuildEndTime ( ) const

Timestamp of when the frame was finished building.

Definition at line 71 of file frame_timings.cc.

                                                         {
  std::scoped_lock state_lock(state_mutex_);
  FML_DCHECK(state_ >= State::kBuildEnd);
  return build_end_;
}

References FML_DCHECK, and kBuildEnd.

◆ GetBuildStartTime()

fml::TimePoint flutter::FrameTimingsRecorder::GetBuildStartTime ( ) const

Timestamp of when the frame building started.

Definition at line 65 of file frame_timings.cc.

                                                           {
  std::scoped_lock state_lock(state_mutex_);
  FML_DCHECK(state_ >= State::kBuildStart);
  return build_start_;
}

References FML_DCHECK, and kBuildStart.

◆ GetFrameNumber()

uint64_t flutter::FrameTimingsRecorder::GetFrameNumber ( ) const

Returns the frame number. Frame number is unique per frame and a frame built earlier will have a frame number less than a frame that has been built at a later point of time.

Definition at line 276 of file frame_timings.cc.

                                                    {
  return frame_number_;
}

Referenced by RecordRasterEnd().

◆ GetFrameNumberTraceArg()

const char * flutter::FrameTimingsRecorder::GetFrameNumberTraceArg ( ) const

Returns the frame number in a fml tracing friendly format.

Definition at line 280 of file frame_timings.cc.

                                                               {
  return frame_number_trace_arg_val_.c_str();
}

◆ GetLayerCacheBytes()

size_t flutter::FrameTimingsRecorder::GetLayerCacheBytes ( ) const

Total Bytes in all layer cache entries.

Total bytes in all layer cache entries.

Definition at line 109 of file frame_timings.cc.

                                                      {
  std::scoped_lock state_lock(state_mutex_);
  FML_DCHECK(state_ >= State::kRasterEnd);
  return layer_cache_bytes_;
}

References FML_DCHECK, and kRasterEnd.

◆ GetLayerCacheCount()

size_t flutter::FrameTimingsRecorder::GetLayerCacheCount ( ) const

Count of the layer cache entries.

Definition at line 102 of file frame_timings.cc.

                                                      {
  std::scoped_lock state_lock(state_mutex_);
  FML_DCHECK(state_ >= State::kRasterEnd);
  return layer_cache_count_;
}

References FML_DCHECK, and kRasterEnd.

◆ GetPictureCacheBytes()

size_t flutter::FrameTimingsRecorder::GetPictureCacheBytes ( ) const

Total Bytes in all picture cache entries.

Total bytes in all picture cache entries.

Definition at line 123 of file frame_timings.cc.

                                                        {
  std::scoped_lock state_lock(state_mutex_);
  FML_DCHECK(state_ >= State::kRasterEnd);
  return picture_cache_bytes_;
}

References FML_DCHECK, and kRasterEnd.

◆ GetPictureCacheCount()

size_t flutter::FrameTimingsRecorder::GetPictureCacheCount ( ) const

Count of the picture cache entries.

Definition at line 116 of file frame_timings.cc.

                                                        {
  std::scoped_lock state_lock(state_mutex_);
  FML_DCHECK(state_ >= State::kRasterEnd);
  return picture_cache_count_;
}

References FML_DCHECK, and kRasterEnd.

◆ GetRasterEndTime()

fml::TimePoint flutter::FrameTimingsRecorder::GetRasterEndTime ( ) const

Timestamp of when the frame rasterization finished.

Definition at line 83 of file frame_timings.cc.

                                                          {
  std::scoped_lock state_lock(state_mutex_);
  FML_DCHECK(state_ >= State::kRasterEnd);
  return raster_end_;
}

References FML_DCHECK, and kRasterEnd.

◆ GetRasterEndWallTime()

fml::TimePoint flutter::FrameTimingsRecorder::GetRasterEndWallTime ( ) const

Timestamp of when the frame rasterization is complete in wall-time.

Definition at line 89 of file frame_timings.cc.

                                                              {
  std::scoped_lock state_lock(state_mutex_);
  FML_DCHECK(state_ >= State::kRasterEnd);
  return raster_end_wall_time_;
}

References FML_DCHECK, and kRasterEnd.

◆ GetRasterStartTime()

fml::TimePoint flutter::FrameTimingsRecorder::GetRasterStartTime ( ) const

Timestamp of when the frame rasterization started.

Definition at line 77 of file frame_timings.cc.

                                                            {
  std::scoped_lock state_lock(state_mutex_);
  FML_DCHECK(state_ >= State::kRasterStart);
  return raster_start_;
}

References FML_DCHECK, and kRasterStart.

◆ GetRecordedTime()

FrameTiming flutter::FrameTimingsRecorder::GetRecordedTime ( ) const

Returns the recorded time from when RecordRasterEnd is called.

Definition at line 233 of file frame_timings.cc.

                                                        {
  std::scoped_lock state_lock(state_mutex_);
  FML_DCHECK(state_ == State::kRasterEnd);
  return timing_;
}

References FML_DCHECK, and kRasterEnd.

◆ GetVsyncStartTime()

fml::TimePoint flutter::FrameTimingsRecorder::GetVsyncStartTime ( ) const

Timestamp of the vsync signal.

Definition at line 53 of file frame_timings.cc.

                                                           {
  std::scoped_lock state_lock(state_mutex_);
  FML_DCHECK(state_ >= State::kVsync);
  return vsync_start_;
}

References FML_DCHECK, and kVsync.

◆ GetVsyncTargetTime()

fml::TimePoint flutter::FrameTimingsRecorder::GetVsyncTargetTime ( ) const

Timestamp of when the frame was targeted to be presented.

This is typically the next vsync signal timestamp.

Definition at line 59 of file frame_timings.cc.

                                                            {
  std::scoped_lock state_lock(state_mutex_);
  FML_DCHECK(state_ >= State::kVsync);
  return vsync_target_;
}

References FML_DCHECK, and kVsync.

◆ RecordBuildEnd()

void flutter::FrameTimingsRecorder::RecordBuildEnd ( fml::TimePoint build_end )

Records a build end event.

Definition at line 142 of file frame_timings.cc.

                                                                {
  fml::Status status = RecordBuildEndImpl(build_end);
  FML_DCHECK(status.ok());
  (void)status;
}

References FML_DCHECK, and fml::Status::ok().

◆ RecordBuildStart()

void flutter::FrameTimingsRecorder::RecordBuildStart ( fml::TimePoint build_start )

Records a build start event.

Definition at line 136 of file frame_timings.cc.

                                                                    {
  fml::Status status = RecordBuildStartImpl(build_start);
  FML_DCHECK(status.ok());
  (void)status;
}

References FML_DCHECK, and fml::Status::ok().

◆ RecordRasterEnd()

FrameTiming flutter::FrameTimingsRecorder::RecordRasterEnd ( const RasterCache * cache = nullptr )

Records a raster end event, and builds a FrameTiming that summarizes all the events. This summary is sent to the framework.

Definition at line 202 of file frame_timings.cc.

                                                                          {
  std::scoped_lock state_lock(state_mutex_);
  FML_DCHECK(state_ == State::kRasterStart);
  state_ = State::kRasterEnd;
  raster_end_ = fml::TimePoint::Now();
  raster_end_wall_time_ = fml::TimePoint::CurrentWallTime();
  if (cache) {
#if !SLIMPELLER
    const RasterCacheMetrics& layer_metrics = cache->layer_metrics();
    const RasterCacheMetrics& picture_metrics = cache->picture_metrics();
    layer_cache_count_ = layer_metrics.total_count();
    layer_cache_bytes_ = layer_metrics.total_bytes();
    picture_cache_count_ = picture_metrics.total_count();
    picture_cache_bytes_ = picture_metrics.total_bytes();
#endif  //  !SLIMPELLER
  } else {
    layer_cache_count_ = layer_cache_bytes_ = picture_cache_count_ =
        picture_cache_bytes_ = 0;
  }
  timing_.Set(FrameTiming::kVsyncStart, vsync_start_);
  timing_.Set(FrameTiming::kBuildStart, build_start_);
  timing_.Set(FrameTiming::kBuildFinish, build_end_);
  timing_.Set(FrameTiming::kRasterStart, raster_start_);
  timing_.Set(FrameTiming::kRasterFinish, raster_end_);
  timing_.Set(FrameTiming::kRasterFinishWallTime, raster_end_wall_time_);
  timing_.SetFrameNumber(GetFrameNumber());
  timing_.SetRasterCacheStatistics(layer_cache_count_, layer_cache_bytes_,
                                   picture_cache_count_, picture_cache_bytes_);
  return timing_;
}

◆ RecordRasterStart()

void flutter::FrameTimingsRecorder::RecordRasterStart ( fml::TimePoint raster_start )

Records a raster start event.

Definition at line 148 of file frame_timings.cc.

                                                                      {
  fml::Status status = RecordRasterStartImpl(raster_start);
  FML_DCHECK(status.ok());
  (void)status;
}

References FML_DCHECK, and fml::Status::ok().

◆ RecordVsync()

void flutter::FrameTimingsRecorder::RecordVsync	(	fml::TimePoint	vsync_start,
		fml::TimePoint	vsync_target
	)

Records a vsync event.

Definition at line 129 of file frame_timings.cc.

                                                                  {
  fml::Status status = RecordVsyncImpl(vsync_start, vsync_target);
  FML_DCHECK(status.ok());
  (void)status;
}

References FML_DCHECK, and fml::Status::ok().

The documentation for this class was generated from the following files:

flow/frame_timings.h
flow/frame_timings.cc

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ FrameTimingsRecorder() [1/2]

◆ FrameTimingsRecorder() [2/2]

◆ ~FrameTimingsRecorder()

Member Function Documentation

◆ AssertInState()

◆ CloneUntil()

◆ GetBuildDuration()

◆ GetBuildEndTime()

◆ GetBuildStartTime()

◆ GetFrameNumber()

◆ GetFrameNumberTraceArg()

◆ GetLayerCacheBytes()

◆ GetLayerCacheCount()

◆ GetPictureCacheBytes()

◆ GetPictureCacheCount()

◆ GetRasterEndTime()

◆ GetRasterEndWallTime()

◆ GetRasterStartTime()

◆ GetRecordedTime()

◆ GetVsyncStartTime()

◆ GetVsyncTargetTime()

◆ RecordBuildEnd()

◆ RecordBuildStart()

◆ RecordRasterEnd()

◆ RecordRasterStart()

◆ RecordVsync()