| // Copyright 2017 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. |
| |
| #include "cc/trees/ukm_manager.h" |
| |
| #include "services/metrics/public/cpp/ukm_builders.h" |
| #include "services/metrics/public/cpp/ukm_recorder.h" |
| |
| namespace cc { |
| |
| UkmManager::UkmManager(std::unique_ptr<ukm::UkmRecorder> recorder) |
| : recorder_(std::move(recorder)) { |
| DCHECK(recorder_); |
| } |
| |
| UkmManager::~UkmManager() { |
| RecordCheckerboardUkm(); |
| RecordRenderingUkm(); |
| } |
| |
| void UkmManager::SetSourceId(ukm::SourceId source_id) { |
| // If we accumulated any metrics, record them before resetting the source. |
| RecordCheckerboardUkm(); |
| RecordRenderingUkm(); |
| |
| source_id_ = source_id; |
| } |
| |
| void UkmManager::SetUserInteractionInProgress(bool in_progress) { |
| if (user_interaction_in_progress_ == in_progress) |
| return; |
| |
| user_interaction_in_progress_ = in_progress; |
| if (!user_interaction_in_progress_) |
| RecordCheckerboardUkm(); |
| } |
| |
| void UkmManager::AddCheckerboardStatsForFrame(int64_t checkerboard_area, |
| int64_t num_missing_tiles, |
| int64_t total_visible_area) { |
| DCHECK_GE(total_visible_area, checkerboard_area); |
| if (source_id_ == ukm::kInvalidSourceId || !user_interaction_in_progress_) |
| return; |
| |
| checkerboarded_content_area_ += checkerboard_area; |
| num_missing_tiles_ += num_missing_tiles; |
| total_visible_area_ += total_visible_area; |
| num_of_frames_++; |
| } |
| |
| void UkmManager::AddCheckerboardedImages(int num_of_checkerboarded_images) { |
| if (user_interaction_in_progress_) { |
| num_of_images_checkerboarded_during_interaction_ += |
| num_of_checkerboarded_images; |
| } |
| total_num_of_checkerboarded_images_ += num_of_checkerboarded_images; |
| } |
| |
| void UkmManager::RecordCheckerboardUkm() { |
| // Only make a recording if there was any visible area from PictureLayers, |
| // which can be checkerboarded. |
| if (num_of_frames_ > 0 && total_visible_area_ > 0) { |
| DCHECK_NE(source_id_, ukm::kInvalidSourceId); |
| ukm::builders::Compositor_UserInteraction(source_id_) |
| .SetCheckerboardedContentArea(checkerboarded_content_area_ / |
| num_of_frames_) |
| .SetNumMissingTiles(num_missing_tiles_ / num_of_frames_) |
| .SetCheckerboardedContentAreaRatio( |
| (checkerboarded_content_area_ * 100) / total_visible_area_) |
| .SetCheckerboardedImagesCount( |
| num_of_images_checkerboarded_during_interaction_) |
| .Record(recorder_.get()); |
| } |
| |
| checkerboarded_content_area_ = 0; |
| num_missing_tiles_ = 0; |
| num_of_frames_ = 0; |
| total_visible_area_ = 0; |
| num_of_images_checkerboarded_during_interaction_ = 0; |
| } |
| |
| void UkmManager::RecordRenderingUkm() { |
| if (source_id_ == ukm::kInvalidSourceId) |
| return; |
| |
| ukm::builders::Compositor_Rendering(source_id_) |
| .SetCheckerboardedImagesCount(total_num_of_checkerboarded_images_) |
| .Record(recorder_.get()); |
| total_num_of_checkerboarded_images_ = 0; |
| } |
| |
| void UkmManager::RecordThroughputUKM( |
| FrameSequenceTrackerType tracker_type, |
| FrameSequenceMetrics::ThreadType thread_type, |
| int64_t throughput) const { |
| ukm::builders::Graphics_Smoothness_Throughput builder(source_id_); |
| switch (thread_type) { |
| case FrameSequenceMetrics::ThreadType::kMain: { |
| switch (tracker_type) { |
| #define CASE_FOR_MAIN_THREAD_TRACKER(name) \ |
| case FrameSequenceTrackerType::k##name: \ |
| builder.SetMainThread_##name(throughput); \ |
| break; |
| CASE_FOR_MAIN_THREAD_TRACKER(CompositorAnimation); |
| CASE_FOR_MAIN_THREAD_TRACKER(MainThreadAnimation); |
| CASE_FOR_MAIN_THREAD_TRACKER(PinchZoom); |
| CASE_FOR_MAIN_THREAD_TRACKER(RAF); |
| CASE_FOR_MAIN_THREAD_TRACKER(TouchScroll); |
| CASE_FOR_MAIN_THREAD_TRACKER(Universal); |
| CASE_FOR_MAIN_THREAD_TRACKER(Video); |
| CASE_FOR_MAIN_THREAD_TRACKER(WheelScroll); |
| #undef CASE_FOR_MAIN_THREAD_TRACKER |
| default: |
| NOTREACHED(); |
| break; |
| } |
| |
| break; |
| } |
| |
| case FrameSequenceMetrics::ThreadType::kCompositor: { |
| switch (tracker_type) { |
| #define CASE_FOR_COMPOSITOR_THREAD_TRACKER(name) \ |
| case FrameSequenceTrackerType::k##name: \ |
| builder.SetCompositorThread_##name(throughput); \ |
| break; |
| CASE_FOR_COMPOSITOR_THREAD_TRACKER(CompositorAnimation); |
| CASE_FOR_COMPOSITOR_THREAD_TRACKER(MainThreadAnimation); |
| CASE_FOR_COMPOSITOR_THREAD_TRACKER(PinchZoom); |
| CASE_FOR_COMPOSITOR_THREAD_TRACKER(RAF); |
| CASE_FOR_COMPOSITOR_THREAD_TRACKER(TouchScroll); |
| CASE_FOR_COMPOSITOR_THREAD_TRACKER(Universal); |
| CASE_FOR_COMPOSITOR_THREAD_TRACKER(Video); |
| CASE_FOR_COMPOSITOR_THREAD_TRACKER(WheelScroll); |
| #undef CASE_FOR_COMPOSITOR_THREAD_TRACKER |
| default: |
| NOTREACHED(); |
| break; |
| } |
| break; |
| } |
| |
| case FrameSequenceMetrics::ThreadType::kSlower: { |
| switch (tracker_type) { |
| #define CASE_FOR_SLOWER_THREAD_TRACKER(name) \ |
| case FrameSequenceTrackerType::k##name: \ |
| builder.SetSlowerThread_##name(throughput); \ |
| break; |
| CASE_FOR_SLOWER_THREAD_TRACKER(CompositorAnimation); |
| CASE_FOR_SLOWER_THREAD_TRACKER(MainThreadAnimation); |
| CASE_FOR_SLOWER_THREAD_TRACKER(PinchZoom); |
| CASE_FOR_SLOWER_THREAD_TRACKER(RAF); |
| CASE_FOR_SLOWER_THREAD_TRACKER(TouchScroll); |
| CASE_FOR_SLOWER_THREAD_TRACKER(Universal); |
| CASE_FOR_SLOWER_THREAD_TRACKER(Video); |
| CASE_FOR_SLOWER_THREAD_TRACKER(WheelScroll); |
| #undef CASE_FOR_SLOWER_THREAD_TRACKER |
| default: |
| NOTREACHED(); |
| break; |
| } |
| break; |
| } |
| default: |
| NOTREACHED(); |
| break; |
| } |
| builder.Record(recorder_.get()); |
| } |
| |
| void UkmManager::RecordLatencyUKM( |
| bool missed_frame, |
| const std::vector<CompositorFrameReporter::StageData>& stage_history, |
| const base::flat_set<FrameSequenceTrackerType>* active_trackers, |
| const viz::FrameTimingDetails& viz_breakdown) const { |
| ukm::builders::Graphics_Smoothness_Latency builder(source_id_); |
| |
| if (missed_frame) |
| builder.SetMissedFrame(true); |
| |
| // Record each stage |
| for (const CompositorFrameReporter::StageData& stage : stage_history) { |
| switch (stage.stage_type) { |
| #define CASE_FOR_STAGE(name) \ |
| case CompositorFrameReporter::StageType::k##name: \ |
| builder.Set##name((stage.end_time - stage.start_time).InMicroseconds()); \ |
| break; |
| CASE_FOR_STAGE(BeginImplFrameToSendBeginMainFrame); |
| CASE_FOR_STAGE(SendBeginMainFrameToCommit); |
| CASE_FOR_STAGE(Commit); |
| CASE_FOR_STAGE(EndCommitToActivation); |
| CASE_FOR_STAGE(Activation); |
| CASE_FOR_STAGE(EndActivateToSubmitCompositorFrame); |
| CASE_FOR_STAGE(TotalLatency); |
| #undef CASE_FOR_STAGE |
| // Break out kSubmitCompositorFrameToPresentationCompositorFrame to report |
| // the viz breakdown. |
| case CompositorFrameReporter::StageType:: |
| kSubmitCompositorFrameToPresentationCompositorFrame: |
| builder.SetSubmitCompositorFrameToPresentationCompositorFrame( |
| (stage.end_time - stage.start_time).InMicroseconds()); |
| if (viz_breakdown.received_compositor_frame_timestamp.is_null()) |
| break; |
| builder |
| .SetSubmitCompositorFrameToPresentationCompositorFrame_SubmitToReceiveCompositorFrame( |
| (viz_breakdown.received_compositor_frame_timestamp - |
| stage.start_time) |
| .InMicroseconds()); |
| if (viz_breakdown.draw_start_timestamp.is_null()) |
| break; |
| builder |
| .SetSubmitCompositorFrameToPresentationCompositorFrame_ReceivedCompositorFrameToStartDraw( |
| (viz_breakdown.draw_start_timestamp - |
| viz_breakdown.received_compositor_frame_timestamp) |
| .InMicroseconds()); |
| if (viz_breakdown.swap_timings.is_null()) |
| break; |
| builder |
| .SetSubmitCompositorFrameToPresentationCompositorFrame_StartDrawToSwapEnd( |
| (viz_breakdown.swap_timings.swap_end - |
| viz_breakdown.draw_start_timestamp) |
| .InMicroseconds()); |
| builder |
| .SetSubmitCompositorFrameToPresentationCompositorFrame_SwapEndToPresentationCompositorFrame( |
| (viz_breakdown.presentation_feedback.timestamp - |
| viz_breakdown.swap_timings.swap_end) |
| .InMicroseconds()); |
| break; |
| default: |
| NOTREACHED(); |
| break; |
| } |
| } |
| |
| // Record the active trackers |
| for (const auto& frame_sequence_tracker_type : *active_trackers) { |
| if (frame_sequence_tracker_type == FrameSequenceTrackerType::kUniversal) |
| continue; |
| switch (frame_sequence_tracker_type) { |
| #define CASE_FOR_TRACKER(name) \ |
| case FrameSequenceTrackerType::k##name: \ |
| builder.Set##name(true); \ |
| break; |
| CASE_FOR_TRACKER(CompositorAnimation); |
| CASE_FOR_TRACKER(MainThreadAnimation); |
| CASE_FOR_TRACKER(PinchZoom); |
| CASE_FOR_TRACKER(RAF); |
| CASE_FOR_TRACKER(TouchScroll); |
| CASE_FOR_TRACKER(Video); |
| CASE_FOR_TRACKER(WheelScroll); |
| #undef CASE_FOR_TRACKER |
| default: |
| NOTREACHED(); |
| break; |
| } |
| } |
| |
| builder.Record(recorder_.get()); |
| } |
| |
| } // namespace cc |
