// Copyright Epic Games, Inc. All Rights Reserved. #include "TimingGraphTrack.h" #include #include "TraceServices/AnalysisService.h" #include "TraceServices/Model/TimingProfiler.h" #include "TraceServices/Model/Counters.h" // Insights #include "Insights/Common/PaintUtils.h" #include "Insights/Common/TimeUtils.h" #include "Insights/InsightsManager.h" #include "Insights/ViewModels/AxisViewportDouble.h" #include "Insights/ViewModels/GraphTrackBuilder.h" #include "Insights/ViewModels/ITimingViewDrawHelper.h" #include "Insights/ViewModels/TimingTrackViewport.h" #define LOCTEXT_NAMESPACE "GraphTrack" //////////////////////////////////////////////////////////////////////////////////////////////////// // FTimingGraphSeries //////////////////////////////////////////////////////////////////////////////////////////////////// FTimingGraphSeries::FTimingGraphSeries(FTimingGraphSeries::ESeriesType InType) : FGraphSeries(), Type(InType), TimerId(0), CachedSessionDuration(0.0), CachedEvents(), bIsTime(InType == FTimingGraphSeries::ESeriesType::Frame || InType == FTimingGraphSeries::ESeriesType::Timer), bIsMemory(false), bIsFloatingPoint(false) { } //////////////////////////////////////////////////////////////////////////////////////////////////// FTimingGraphSeries::~FTimingGraphSeries() { } //////////////////////////////////////////////////////////////////////////////////////////////////// FString FTimingGraphSeries::FormatValue(double Value) const { switch (Type) { case FTimingGraphSeries::ESeriesType::Frame: return FString::Printf(TEXT("%s (%g fps)"), *TimeUtils::FormatTimeAuto(Value), 1.0 / Value); case FTimingGraphSeries::ESeriesType::Timer: return TimeUtils::FormatTimeAuto(Value); case FTimingGraphSeries::ESeriesType::StatsCounter: if (bIsTime) { return TimeUtils::FormatTimeAuto(Value); } else if (bIsMemory) { const int64 MemValue = static_cast(Value); return FString::Printf(TEXT("%s (%s bytes)"), *FText::AsMemory(MemValue).ToString(), *FText::AsNumber(MemValue).ToString()); } else if (bIsFloatingPoint) { return FString::Printf(TEXT("%g"), Value); } else { const int64 Int64Value = static_cast(Value); return FText::AsNumber(Int64Value).ToString(); } } return FGraphSeries::FormatValue(Value); } //////////////////////////////////////////////////////////////////////////////////////////////////// // FTimingGraphTrack //////////////////////////////////////////////////////////////////////////////////////////////////// INSIGHTS_IMPLEMENT_RTTI(FTimingGraphTrack) //////////////////////////////////////////////////////////////////////////////////////////////////// FTimingGraphTrack::FTimingGraphTrack() : FGraphTrack() //, SharedValueViewport() { EnabledOptions = // EGraphOptions::ShowDebugInfo | // EGraphOptions::ShowPoints | EGraphOptions::ShowPointsWithBorder | EGraphOptions::ShowLines | EGraphOptions::ShowPolygon | EGraphOptions::UseEventDuration | // EGraphOptions::ShowBars | EGraphOptions::ShowBaseline | EGraphOptions::ShowVerticalAxisGrid | EGraphOptions::ShowHeader | EGraphOptions::None; } //////////////////////////////////////////////////////////////////////////////////////////////////// FTimingGraphTrack::~FTimingGraphTrack() { } //////////////////////////////////////////////////////////////////////////////////////////////////// void FTimingGraphTrack::Update(const ITimingTrackUpdateContext& Context) { FGraphTrack::Update(Context); const bool bIsEntireGraphTrackDirty = IsDirty() || Context.GetViewport().IsHorizontalViewportDirty(); bool bNeedsUpdate = bIsEntireGraphTrackDirty; if (!bNeedsUpdate) { for (TSharedPtr& Series: AllSeries) { if (Series->IsVisible() && Series->IsDirty()) { // At least one series is dirty. bNeedsUpdate = true; break; } } } if (bNeedsUpdate) { ClearDirtyFlag(); NumAddedEvents = 0; const FTimingTrackViewport& Viewport = Context.GetViewport(); for (TSharedPtr& Series: AllSeries) { if (Series->IsVisible() && (bIsEntireGraphTrackDirty || Series->IsDirty())) { // Clear the flag before updating, because the update itself may further need to set the series as dirty. Series->ClearDirtyFlag(); TSharedPtr TimingSeries = StaticCastSharedPtr(Series); switch (TimingSeries->Type) { case FTimingGraphSeries::ESeriesType::Frame: UpdateFrameSeries(*TimingSeries, Viewport); break; case FTimingGraphSeries::ESeriesType::Timer: UpdateTimerSeries(*TimingSeries, Viewport); break; case FTimingGraphSeries::ESeriesType::StatsCounter: UpdateStatsCounterSeries(*TimingSeries, Viewport); break; } } } UpdateStats(); } } //////////////////////////////////////////////////////////////////////////////////////////////////// // Frame Series //////////////////////////////////////////////////////////////////////////////////////////////////// void FTimingGraphTrack::AddDefaultFrameSeries() { TSharedRef GameFramesSeries = MakeShared(FTimingGraphSeries::ESeriesType::Frame); GameFramesSeries->SetName(TEXT("Game Frames")); GameFramesSeries->SetDescription(TEXT("Duration of Game frames")); GameFramesSeries->SetColor(FLinearColor(0.3f, 0.3f, 1.0f, 1.0f), FLinearColor(1.0f, 1.0f, 1.0f, 1.0f)); GameFramesSeries->FrameType = TraceFrameType_Game; GameFramesSeries->SetBaselineY(SharedValueViewport.GetBaselineY()); GameFramesSeries->SetScaleY(SharedValueViewport.GetScaleY()); GameFramesSeries->EnableSharedViewport(); AllSeries.Add(GameFramesSeries); TSharedRef RenderingFramesSeries = MakeShared(FTimingGraphSeries::ESeriesType::Frame); RenderingFramesSeries->SetName(TEXT("Rendering Frames")); RenderingFramesSeries->SetDescription(TEXT("Duration of Rendering frames")); RenderingFramesSeries->SetColor(FLinearColor(1.0f, 0.3f, 0.3f, 1.0f), FLinearColor(1.0f, 1.0f, 1.0f, 1.0f)); RenderingFramesSeries->FrameType = TraceFrameType_Rendering; RenderingFramesSeries->SetBaselineY(SharedValueViewport.GetBaselineY()); RenderingFramesSeries->SetScaleY(SharedValueViewport.GetScaleY()); RenderingFramesSeries->EnableSharedViewport(); AllSeries.Add(RenderingFramesSeries); } //////////////////////////////////////////////////////////////////////////////////////////////////// void FTimingGraphTrack::UpdateFrameSeries(FTimingGraphSeries& Series, const FTimingTrackViewport& Viewport) { FGraphTrackBuilder Builder(*this, Series, Viewport); TSharedPtr Session = FInsightsManager::Get()->GetSession(); if (Session.IsValid()) { Trace::FAnalysisSessionReadScope SessionReadScope(*Session.Get()); const Trace::IFrameProvider& FramesProvider = ReadFrameProvider(*Session.Get()); const TArray64& FrameStartTimes = FramesProvider.GetFrameStartTimes(Series.FrameType); const int64 StartLowerBound = Algo::LowerBound(FrameStartTimes, Viewport.GetStartTime()); const uint64 StartIndex = (StartLowerBound > 1) ? StartLowerBound - 2 : 0; const int64 EndLowerBound = Algo::LowerBound(FrameStartTimes, Viewport.GetEndTime()); const uint64 EndIndex = EndLowerBound + 1; FramesProvider.EnumerateFrames(Series.FrameType, StartIndex, EndIndex, [&Builder](const Trace::FFrame& Frame) { // TODO: add a "frame converter" (i.e. to fps, miliseconds or seconds) const double Duration = Frame.EndTime - Frame.StartTime; Builder.AddEvent(Frame.StartTime, Duration, Duration); }); } } //////////////////////////////////////////////////////////////////////////////////////////////////// // Timer Series //////////////////////////////////////////////////////////////////////////////////////////////////// TSharedPtr FTimingGraphTrack::GetTimerSeries(uint32 TimerId) { TSharedPtr* Ptr = AllSeries.FindByPredicate([TimerId](const TSharedPtr& Series) { const TSharedPtr TimingSeries = StaticCastSharedPtr(Series); return TimingSeries->Type == FTimingGraphSeries::ESeriesType::Timer && TimingSeries->TimerId == TimerId; }); return (Ptr != nullptr) ? StaticCastSharedPtr(*Ptr) : nullptr; } //////////////////////////////////////////////////////////////////////////////////////////////////// TSharedPtr FTimingGraphTrack::AddTimerSeries(uint32 TimerId, FLinearColor Color) { TSharedRef Series = MakeShared(FTimingGraphSeries::ESeriesType::Timer); Series->SetName(TEXT("")); Series->SetDescription(TEXT("Timer series")); const FLinearColor BorderColor(Color.R + 0.4f, Color.G + 0.4f, Color.B + 0.4f, 1.0f); Series->SetColor(Color, BorderColor); Series->TimerId = TimerId; // Series->CpuOrGpu = ; // Series->TimelineIndex = ; // Use shared viewport. Series->SetBaselineY(SharedValueViewport.GetBaselineY()); Series->SetScaleY(SharedValueViewport.GetScaleY()); Series->EnableSharedViewport(); Series->CachedSessionDuration = 0.0; AllSeries.Add(Series); return Series; } //////////////////////////////////////////////////////////////////////////////////////////////////// void FTimingGraphTrack::RemoveTimerSeries(uint32 TimerId) { AllSeries.RemoveAll([TimerId](const TSharedPtr& Series) { const TSharedPtr TimingSeries = StaticCastSharedPtr(Series); return TimingSeries->Type == FTimingGraphSeries::ESeriesType::Timer && TimingSeries->TimerId == TimerId; }); } //////////////////////////////////////////////////////////////////////////////////////////////////// void FTimingGraphTrack::UpdateTimerSeries(FTimingGraphSeries& Series, const FTimingTrackViewport& Viewport) { FGraphTrackBuilder Builder(*this, Series, Viewport); TSharedPtr Session = FInsightsManager::Get()->GetSession(); if (Session.IsValid()) { Trace::FAnalysisSessionReadScope SessionReadScope(*Session.Get()); const double SessionDuration = Session->GetDurationSeconds(); if (Series.CachedSessionDuration != SessionDuration) { Series.CachedSessionDuration = SessionDuration; const Trace::ITimingProfilerProvider& TimingProfilerProvider = *Trace::ReadTimingProfilerProvider(*Session.Get()); const Trace::ITimingProfilerTimerReader* TimerReader; TimingProfilerProvider.ReadTimers([&TimerReader](const Trace::ITimingProfilerTimerReader& Out) { TimerReader = &Out; }); const uint32 TimelineCount = TimingProfilerProvider.GetTimelineCount(); uint32 NumTimelinesContainingEvent = 0; for (uint32 TimelineIndex = 0; TimelineIndex < TimelineCount; ++TimelineIndex) { TimingProfilerProvider.ReadTimeline(TimelineIndex, [SessionDuration, &Series, TimerReader, &Viewport, &NumTimelinesContainingEvent](const Trace::ITimingProfilerProvider::Timeline& Timeline) { TArray> Events; Trace::ITimeline::EnumerateAsyncParams Params; Params.IntervalStart = 0; Params.IntervalEnd = SessionDuration; Params.Resolution = 0.0; Params.SetupCallback = [&Events](uint32 NumTasks) { Events.AddDefaulted(NumTasks); }; Params.Callback = [&Events, TimerReader, &Series](double StartTime, double EndTime, uint32 Depth, const Trace::FTimingProfilerEvent& Event, uint32 TaskIndex) { const Trace::FTimingProfilerTimer* Timer = TimerReader->GetTimer(Event.TimerIndex); if (ensure(Timer != nullptr)) { if (Timer->Id == Series.TimerId) { const double Duration = EndTime - StartTime; Events[TaskIndex].Add({StartTime, Duration}); } } return Trace::EEventEnumerate::Continue; }; Timeline.EnumerateEventsDownSampledAsync(Params); int32 NumOfCachedEvents = Series.CachedEvents.Num(); for (auto& Array: Events) { for (auto& Event: Array) { Series.CachedEvents.Add(Event); } Array.Empty(); } if (NumOfCachedEvents != Series.CachedEvents.Num()) { ++NumTimelinesContainingEvent; } }); } // If events come from multiple timelines, we have to sort the whole thing. // If they come from a single timeline, they are already sorted. if (NumTimelinesContainingEvent > 1) { Series.CachedEvents.Sort(&FTimingGraphSeries::CompareEventsByStartTime); } } int32 StartIndex = Algo::UpperBoundBy(Series.CachedEvents, Viewport.GetStartTime(), &FTimingGraphSeries::FSimpleTimingEvent::StartTime); if (StartIndex > 0) { StartIndex--; } int32 EndIndex = Algo::UpperBoundBy(Series.CachedEvents, Viewport.GetEndTime(), &FTimingGraphSeries::FSimpleTimingEvent::StartTime); if (EndIndex < Series.CachedEvents.Num()) { EndIndex++; } for (int32 Index = StartIndex; Index < EndIndex; ++Index) { const FTimingGraphSeries::FSimpleTimingEvent& Event = Series.CachedEvents[Index]; Builder.AddEvent(Event.StartTime, Event.Duration, Event.Duration); } } } //////////////////////////////////////////////////////////////////////////////////////////////////// // Stats Counter Series //////////////////////////////////////////////////////////////////////////////////////////////////// TSharedPtr FTimingGraphTrack::GetStatsCounterSeries(uint32 CounterId) { TSharedPtr* Ptr = AllSeries.FindByPredicate([CounterId](const TSharedPtr& Series) { const TSharedPtr TimingSeries = StaticCastSharedPtr(Series); return TimingSeries->Type == FTimingGraphSeries::ESeriesType::StatsCounter && TimingSeries->CounterId == CounterId; }); return (Ptr != nullptr) ? StaticCastSharedPtr(*Ptr) : nullptr; } //////////////////////////////////////////////////////////////////////////////////////////////////// TSharedPtr FTimingGraphTrack::AddStatsCounterSeries(uint32 CounterId, FLinearColor Color) { TSharedRef Series = MakeShared(FTimingGraphSeries::ESeriesType::StatsCounter); const TCHAR* CounterName = nullptr; bool bIsTime = false; bool bIsMemory = false; bool bIsFloatingPoint = false; TSharedPtr Session = FInsightsManager::Get()->GetSession(); if (Session.IsValid()) { Trace::FAnalysisSessionReadScope SessionReadScope(*Session.Get()); const Trace::ICounterProvider& CountersProvider = Trace::ReadCounterProvider(*Session.Get()); if (CounterId < CountersProvider.GetCounterCount()) { CountersProvider.ReadCounter(CounterId, [&](const Trace::ICounter& Counter) { CounterName = Counter.GetName(); // bIsTime = (Counter.GetDisplayHint() == Trace::CounterDisplayHint_Time); bIsMemory = (Counter.GetDisplayHint() == Trace::CounterDisplayHint_Memory); bIsFloatingPoint = Counter.IsFloatingPoint(); }); } } Series->SetName(CounterName != nullptr ? CounterName : TEXT("")); Series->SetDescription(TEXT("Stats counter series")); FLinearColor BorderColor(Color.R + 0.4f, Color.G + 0.4f, Color.B + 0.4f, 1.0f); Series->SetColor(Color, BorderColor); Series->CounterId = CounterId; Series->bIsTime = bIsTime; Series->bIsMemory = bIsMemory; Series->bIsFloatingPoint = bIsFloatingPoint; Series->SetBaselineY(GetHeight() - 1.0f); Series->SetScaleY(1.0); Series->EnableAutoZoom(); AllSeries.Add(Series); return Series; } //////////////////////////////////////////////////////////////////////////////////////////////////// void FTimingGraphTrack::RemoveStatsCounterSeries(uint32 CounterId) { AllSeries.RemoveAll([CounterId](const TSharedPtr& Series) { const TSharedPtr TimingSeries = StaticCastSharedPtr(Series); return TimingSeries->Type == FTimingGraphSeries::ESeriesType::StatsCounter && TimingSeries->CounterId == CounterId; }); } //////////////////////////////////////////////////////////////////////////////////////////////////// void FTimingGraphTrack::UpdateStatsCounterSeries(FTimingGraphSeries& Series, const FTimingTrackViewport& Viewport) { FGraphTrackBuilder Builder(*this, Series, Viewport); TSharedPtr Session = FInsightsManager::Get()->GetSession(); if (Session.IsValid()) { Trace::FAnalysisSessionReadScope SessionReadScope(*Session.Get()); const Trace::ICounterProvider& CounterProvider = Trace::ReadCounterProvider(*Session.Get()); CounterProvider.ReadCounter(Series.CounterId, [this, &Viewport, &Builder, &Series](const Trace::ICounter& Counter) { const float TopY = 4.0f; const float BottomY = GetHeight() - 4.0f; if (Series.IsAutoZoomEnabled() && TopY < BottomY) { double MinValue = std::numeric_limits::infinity(); double MaxValue = -std::numeric_limits::infinity(); if (Counter.IsFloatingPoint()) { Counter.EnumerateFloatValues(Viewport.GetStartTime(), Viewport.GetEndTime(), true, [&Builder, &MinValue, &MaxValue](double Time, double Value) { if (Value < MinValue) { MinValue = Value; } if (Value > MaxValue) { MaxValue = Value; } }); } else { Counter.EnumerateValues(Viewport.GetStartTime(), Viewport.GetEndTime(), true, [&Builder, &MinValue, &MaxValue](double Time, int64 IntValue) { const double Value = static_cast(IntValue); if (Value < MinValue) { MinValue = Value; } if (Value > MaxValue) { MaxValue = Value; } }); } Series.UpdateAutoZoom(TopY, BottomY, MinValue, MaxValue); } if (Counter.IsFloatingPoint()) { Counter.EnumerateFloatValues(Viewport.GetStartTime(), Viewport.GetEndTime(), true, [&Builder](double Time, double Value) { // TODO: add a "value unit converter" Builder.AddEvent(Time, 0.0, Value); }); } else { Counter.EnumerateValues(Viewport.GetStartTime(), Viewport.GetEndTime(), true, [&Builder](double Time, int64 IntValue) { // TODO: add a "value unit converter" Builder.AddEvent(Time, 0.0, static_cast(IntValue)); }); } }); } } //////////////////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////////////////// void FTimingGraphTrack::DrawVerticalAxisGrid(const ITimingTrackDrawContext& Context) const { TSharedPtr FirstTimeUnitSeries; for (const TSharedPtr& Series: AllSeries) { if (Series->IsVisible()) { TSharedPtr TimingSeries = StaticCastSharedPtr(Series); if (TimingSeries->bIsTime) { FirstTimeUnitSeries = TimingSeries; break; } } } if (!FirstTimeUnitSeries) { return; } FAxisViewportDouble ViewportY; ViewportY.SetSize(GetHeight()); ViewportY.SetScaleLimits(std::numeric_limits::min(), std::numeric_limits::max()); ViewportY.SetScale(SharedValueViewport.GetScaleY()); ViewportY.ScrollAtPos(SharedValueViewport.GetBaselineY() - GetHeight()); const float ViewWidth = Context.GetViewport().GetWidth(); const float RoundedViewHeight = FMath::RoundToFloat(GetHeight()); const float X0 = ViewWidth - 12.0f; // let some space for the vertical scrollbar const float Y0 = GetPosY(); constexpr float MinDY = 32.0f; // min vertical distance between horizontal grid lines constexpr float TextH = 14.0f; // label height FDrawContext& DrawContext = Context.GetDrawContext(); const FSlateBrush* Brush = Context.GetHelper().GetWhiteBrush(); // const FSlateFontInfo& Font = Context.GetHelper().GetEventFont(); const TSharedRef FontMeasureService = FSlateApplication::Get().GetRenderer()->GetFontMeasureService(); const double TopValue = ViewportY.GetValueAtOffset(RoundedViewHeight); const double GridValue = ViewportY.GetValueAtOffset(MinDY); const double BottomValue = ViewportY.GetValueAtOffset(0.0f); const double Delta = GridValue - BottomValue; if (Delta > 0.0) { const double Thresholds[] = { 1.0e-9, // 1ns 1.0e-8, // 10ns 1.0e-7, // 100ns 1.0e-6, // 1us 1.0e-5, // 10us 0.0001, // 100us 0.001, // 1ms 0.01, // 10ms 0.1, // 100ms 1.0, // 1s 10.0, // 10s 60.0, // 1m 600.0, // 10m 3600.0, // 1h 36000.0, // 10h 86400.0 // 1d }; constexpr int32 NumThresholds = sizeof(Thresholds) / sizeof(double); int32 Index = Algo::LowerBound(Thresholds, Delta); if (Index > 0) { Index--; } double TickUnit = Thresholds[Index]; int64 DeltaTicks = static_cast(FMath::CeilToDouble(Delta / TickUnit)); if (Index < NumThresholds - 1) { const double NextTickUnit = Thresholds[Index + 1]; if (NextTickUnit <= (DeltaTicks + 1) * TickUnit) { TickUnit = NextTickUnit; DeltaTicks = 1; } else if (DeltaTicks != 1 && DeltaTicks != 5 && DeltaTicks % 2 == 1) // prefer even grid values { DeltaTicks++; } } const double Grid = DeltaTicks * TickUnit; const double StartValue = FMath::GridSnap(BottomValue, Grid); const FLinearColor GridColor(0.0f, 0.0f, 0.0f, 0.1f); const FLinearColor TextBgColor(0.05f, 0.05f, 0.05f, 1.0f); const FLinearColor TextColor = FirstTimeUnitSeries->GetColor().CopyWithNewOpacity(1.0f); for (double Value = StartValue; Value < TopValue; Value += Grid) { const float Y = Y0 + RoundedViewHeight - FMath::RoundToFloat(ViewportY.GetOffsetForValue(Value)); const FString LabelText = TimeUtils::FormatTimeAuto(Value); // Draw horizontal grid line. DrawContext.DrawBox(0, Y, ViewWidth, 1, Brush, GridColor); const FVector2D LabelTextSize = FontMeasureService->Measure(LabelText, Font); const float LabelX = X0 - LabelTextSize.X - 4.0f; const float LabelY = FMath::Min(Y0 + GetHeight() - TextH, FMath::Max(Y0, Y - TextH / 2)); // Draw background for value text. DrawContext.DrawBox(LabelX, LabelY, LabelTextSize.X + 4.0f, TextH, Brush, TextBgColor); // Draw value text. DrawContext.DrawText(LabelX + 2.0f, LabelY + 1.0f, LabelText, Font, TextColor); } DrawContext.LayerId++; } } //////////////////////////////////////////////////////////////////////////////////////////////////// #undef LOCTEXT_NAMESPACE