Files
UnrealEngineUWP/Engine/Source/Runtime/RenderCore/Private/RenderGraphPrivate.cpp
zach bethel 2230e96167 Removal of RDG drain experiment for UE5 release. It is currently unused and hasn't proven itself necessary yet. It would be relatively straightforward to re-add if the need arises in the future.
#rb mihnea.balta
#preflight 61f82d9b3e13556eb9c3eb34

#ROBOMERGE-AUTHOR: zach.bethel
#ROBOMERGE-SOURCE: CL 18794948 in //UE5/Release-5.0/... via CL 18795422 via CL 18796381
#ROBOMERGE-BOT: UE5 (Release-Engine-Test -> Main) (v908-18788545)

[CL 18796735 by zach bethel in ue5-main branch]
2022-01-31 15:55:31 -05:00

566 lines
17 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#include "RenderGraphPrivate.h"
#if RDG_ENABLE_DEBUG
int32 GRDGDumpGraphUnknownCount = 0;
int32 GRDGImmediateMode = 0;
FAutoConsoleVariableRef CVarImmediateMode(
TEXT("r.RDG.ImmediateMode"),
GRDGImmediateMode,
TEXT("Executes passes as they get created. Useful to have a callstack of the wiring code when crashing in the pass' lambda."),
ECVF_RenderThreadSafe);
int32 GRDGDebug = 0;
FAutoConsoleVariableRef CVarRDGDebug(
TEXT("r.RDG.Debug"),
GRDGDebug,
TEXT("Allow to output warnings for inefficiencies found during wiring and execution of the passes.\n")
TEXT(" 0: disabled;\n")
TEXT(" 1: emit warning once (default);\n")
TEXT(" 2: emit warning everytime issue is detected."),
ECVF_RenderThreadSafe);
int32 GRDGDebugFlushGPU = 0;
FAutoConsoleVariableRef CVarRDGDebugFlushGPU(
TEXT("r.RDG.Debug.FlushGPU"),
GRDGDebugFlushGPU,
TEXT("Enables flushing the GPU after every pass. Disables async compute when set (r.RDG.AsyncCompute=0).\n")
TEXT(" 0: disabled (default);\n")
TEXT(" 1: enabled (default)."),
FConsoleVariableDelegate::CreateLambda([](IConsoleVariable*)
{
if (GRDGDebugFlushGPU)
{
GRDGAsyncCompute = 0;
}
}),
ECVF_RenderThreadSafe);
int32 GRDGDebugExtendResourceLifetimes = 0;
FAutoConsoleVariableRef CVarRDGDebugExtendResourceLifetimes(
TEXT("r.RDG.Debug.ExtendResourceLifetimes"),
GRDGDebugExtendResourceLifetimes,
TEXT("Extends the resource lifetimes of resources (or a specific resource filter specified by r.RDG.Debug.ResourceFilter) ")
TEXT("so that they cannot overlap memory with any other resource within the graph. Useful to debug if transient aliasing is causing issues.\n")
TEXT(" 0: disabled (default);\n")
TEXT(" 1: enabled;\n"),
ECVF_RenderThreadSafe);
int32 GRDGDebugDisableTransientResources = 0;
FAutoConsoleVariableRef CVarRDGDebugDisableTransientResource(
TEXT("r.RDG.Debug.DisableTransientResources"),
GRDGDebugDisableTransientResources,
TEXT("Filters out transient resources from the transient allocator. Use r.rdg.debug.resourcefilter to specify the filter. Defaults to all resources if enabled."),
ECVF_RenderThreadSafe);
int32 GRDGDumpGraph = 0;
FAutoConsoleVariableRef CVarDumpGraph(
TEXT("r.RDG.DumpGraph"),
GRDGDumpGraph,
TEXT("Dumps several visualization logs to disk.\n")
TEXT(" 0: disabled;\n")
TEXT(" 1: visualizes producer / consumer pass dependencies;\n")
TEXT(" 2: visualizes resource states and transitions;\n")
TEXT(" 3: visualizes graphics / async compute overlap;\n"),
FConsoleVariableDelegate::CreateLambda([](IConsoleVariable*)
{
if (GRDGDumpGraph)
{
GRDGDebug = 1;
}
}),
ECVF_RenderThreadSafe);
int32 GRDGBreakpoint = 0;
FAutoConsoleVariableRef CVarRDGBreakpoint(
TEXT("r.RDG.Breakpoint"),
GRDGBreakpoint,
TEXT("Breakpoint in debugger when certain conditions are met.\n")
TEXT(" 0: off (default);\n")
TEXT(" 1: On an RDG warning;\n")
TEXT(" 2: When a graph / pass matching the debug filters compiles;\n")
TEXT(" 3: When a graph / pass matching the debug filters executes;\n")
TEXT(" 4: When a graph / pass / resource matching the debug filters is created or destroyed;\n"),
ECVF_RenderThreadSafe);
int32 GRDGClobberResources = 0;
FAutoConsoleVariableRef CVarRDGClobberResources(
TEXT("r.RDG.ClobberResources"),
GRDGClobberResources,
TEXT("Clears all render targets and texture / buffer UAVs with the requested clear color at allocation time. Useful for debugging.\n")
TEXT(" 0:off (default);\n")
TEXT(" 1: 1000 on RGBA channels;\n")
TEXT(" 2: NaN on RGBA channels;\n")
TEXT(" 3: +INFINITY on RGBA channels.\n"),
ECVF_Cheat | ECVF_RenderThreadSafe);
int32 GRDGOverlapUAVs = 1;
FAutoConsoleVariableRef CVarRDGOverlapUAVs(
TEXT("r.RDG.OverlapUAVs"), GRDGOverlapUAVs,
TEXT("RDG will overlap UAV work when requested; if disabled, UAV barriers are always inserted."),
ECVF_RenderThreadSafe);
int32 GRDGTransitionLog = 0;
FAutoConsoleVariableRef CVarRDGTransitionLog(
TEXT("r.RDG.TransitionLog"), GRDGTransitionLog,
TEXT("Logs resource transitions to the console.\n")
TEXT(" 0: disabled(default);\n")
TEXT(">0: enabled for N frames;\n")
TEXT("<0: enabled;\n"),
ECVF_RenderThreadSafe);
TAutoConsoleVariable<FString> CVarRDGDebugGraphFilter(
TEXT("r.RDG.Debug.GraphFilter"), TEXT(""),
TEXT("Filters certain debug events to a specific graph. Set to 'None' to reset.\n"),
ECVF_Default);
FString GRDGDebugGraphFilterName;
inline FString GetDebugFilterString(const FString& InputString)
{
if (!InputString.Compare(TEXT("None"), ESearchCase::IgnoreCase))
{
return {};
}
return InputString;
}
FAutoConsoleVariableSink CVarRDGDebugGraphSink(FConsoleCommandDelegate::CreateLambda([]()
{
GRDGDebugGraphFilterName = GetDebugFilterString(CVarRDGDebugGraphFilter.GetValueOnGameThread());
}));
inline bool IsDebugAllowed(const FString& FilterString, const TCHAR* Name)
{
if (FilterString.IsEmpty())
{
return true;
}
const bool bInverted = FilterString[0] == '!';
if (FilterString.Len() == 1 && bInverted)
{
return true;
}
const TCHAR* FilterStringRaw = *FilterString;
if (bInverted)
{
FilterStringRaw++;
}
const bool bFound = FCString::Strifind(Name, FilterStringRaw) != nullptr;
return bFound ^ bInverted;
}
bool IsDebugAllowedForGraph(const TCHAR* GraphName)
{
return IsDebugAllowed(GRDGDebugGraphFilterName, GraphName);
}
TAutoConsoleVariable<FString> CVarRDGDebugPassFilter(
TEXT("r.RDG.Debug.PassFilter"), TEXT(""),
TEXT("Filters certain debug events to specific passes. Set to 'None' to reset.\n"),
ECVF_Default);
FString GRDGDebugPassFilterName;
FAutoConsoleVariableSink CVarRDGDebugPassSink(FConsoleCommandDelegate::CreateLambda([]()
{
GRDGDebugPassFilterName = GetDebugFilterString(CVarRDGDebugPassFilter.GetValueOnGameThread());
}));
bool IsDebugAllowedForPass(const TCHAR* PassName)
{
return IsDebugAllowed(GRDGDebugPassFilterName, PassName);
}
TAutoConsoleVariable<FString> CVarRDGDebugResourceFilter(
TEXT("r.RDG.Debug.ResourceFilter"), TEXT(""),
TEXT("Filters certain debug events to a specific resource. Set to 'None' to reset.\n"),
ECVF_Default);
FString GRDGDebugResourceFilterName;
FAutoConsoleVariableSink CVarRDGDebugResourceSink(FConsoleCommandDelegate::CreateLambda([]()
{
GRDGDebugResourceFilterName = GetDebugFilterString(CVarRDGDebugResourceFilter.GetValueOnGameThread());
}));
bool IsDebugAllowedForResource(const TCHAR* ResourceName)
{
return IsDebugAllowed(GRDGDebugResourceFilterName, ResourceName);
}
static float GetClobberValue()
{
switch (GRDGClobberResources)
{
case 1:
return 1000.0f;
case 2:
return NAN;
case 3:
return INFINITY;
}
return 0.0f;
}
FLinearColor GetClobberColor()
{
float ClobberValue = GetClobberValue();
return FLinearColor(ClobberValue, ClobberValue, ClobberValue, ClobberValue);
}
uint32 GetClobberBufferValue()
{
float ClobberValue = GetClobberValue();
uint32 ClobberValueUint = reinterpret_cast<const uint32*>(&ClobberValue)[0];
return ClobberValueUint;
}
float GetClobberDepth()
{
return 0.123456789f;
}
uint8 GetClobberStencil()
{
return 123;
}
void EmitRDGWarning(const FString& WarningMessage)
{
if (!GRDGDebug)
{
return;
}
static TSet<FString> GAlreadyEmittedWarnings;
const int32 kRDGEmitWarningsOnce = 1;
if (GRDGDebug == kRDGEmitWarningsOnce)
{
if (!GAlreadyEmittedWarnings.Contains(WarningMessage))
{
GAlreadyEmittedWarnings.Add(WarningMessage);
UE_LOG(LogRDG, Warning, TEXT("%s"), *WarningMessage);
if (GRDGBreakpoint == RDG_BREAKPOINT_WARNINGS)
{
UE_DEBUG_BREAK();
}
}
}
else
{
UE_LOG(LogRDG, Warning, TEXT("%s"), *WarningMessage);
if (GRDGBreakpoint == RDG_BREAKPOINT_WARNINGS)
{
UE_DEBUG_BREAK();
}
}
}
bool GRDGAllowRHIAccess = false;
#endif
int32 GRDGAsyncCompute = 1;
TAutoConsoleVariable<int32> CVarRDGAsyncCompute(
TEXT("r.RDG.AsyncCompute"),
RDG_ASYNC_COMPUTE_ENABLED,
TEXT("Controls the async compute policy.\n")
TEXT(" 0:disabled, no async compute is used;\n")
TEXT(" 1:enabled for passes tagged for async compute (default);\n")
TEXT(" 2:enabled for all compute passes implemented to use the compute command list;\n"),
ECVF_RenderThreadSafe);
FAutoConsoleVariableSink CVarRDGAsyncComputeSink(FConsoleCommandDelegate::CreateLambda([]()
{
GRDGAsyncCompute = CVarRDGAsyncCompute.GetValueOnGameThread();
if (GRDGAsyncCompute && !GSupportsEfficientAsyncCompute)
{
GRDGAsyncCompute = 0;
}
}));
int32 GRDGCullPasses = 1;
FAutoConsoleVariableRef CVarRDGCullPasses(
TEXT("r.RDG.CullPasses"),
GRDGCullPasses,
TEXT("The graph will cull passes with unused outputs.\n")
TEXT(" 0:off;\n")
TEXT(" 1:on(default);\n"),
ECVF_RenderThreadSafe);
int32 GRDGMergeRenderPasses = 1;
FAutoConsoleVariableRef CVarRDGMergeRenderPasses(
TEXT("r.RDG.MergeRenderPasses"),
GRDGMergeRenderPasses,
TEXT("The graph will merge identical, contiguous render passes into a single render pass.\n")
TEXT(" 0:off;\n")
TEXT(" 1:on(default);\n"),
ECVF_RenderThreadSafe);
int32 GRDGTransientAllocator = 1;
FAutoConsoleVariableRef CVarRDGUseTransientAllocator(
TEXT("r.RDG.TransientAllocator"), GRDGTransientAllocator,
TEXT("RDG will use the RHITransientResourceAllocator to allocate all transient resources.")
TEXT(" 0: disables the transient allocator;")
TEXT(" 1: enables the transient allocator (default);")
TEXT(" 2: enables the transient allocator for resources with FastVRAM flag only"),
ECVF_RenderThreadSafe);
int32 GRDGTransientExtractedResources = 1;
FAutoConsoleVariableRef CVarRDGTransientExtractedResource(
TEXT("r.RDG.TransientExtractedResources"), GRDGTransientExtractedResources,
TEXT("RDG will allocate extracted resources as transient, unless explicitly marked non-transient by the user.")
TEXT(" 0: disables external transient resources;")
TEXT(" 1: enables external transient resources (default);")
TEXT(" 2: force enables all external transient resources (not recommended);"),
ECVF_RenderThreadSafe);
int32 GRDGParallelExecute = 1;
FAutoConsoleVariableRef CVarRDGParallelExecute(
TEXT("r.RDG.ParallelExecute"), GRDGParallelExecute,
TEXT("Whether to enable parallel execution of passes when supported.")
TEXT(" 0: off;")
TEXT(" 1: on (default)"),
FConsoleVariableDelegate::CreateLambda([](IConsoleVariable* Variable)
{
if (Variable->GetInt())
{
if (GRDGParallelExecutePassMax <= 1)
{
GRDGParallelExecutePassMax = 1;
}
if (GRDGParallelExecutePassMin < GRDGParallelExecutePassMax)
{
GRDGParallelExecutePassMin = GRDGParallelExecutePassMax;
}
}
}),
ECVF_RenderThreadSafe);
int32 GRDGParallelExecutePassMin = 1;
FAutoConsoleVariableRef CVarRDGParallelExecutePassMin(
TEXT("r.RDG.ParallelExecute.PassMin"), GRDGParallelExecutePassMin,
TEXT("The minimum span of contiguous passes eligible for parallel execution for the span to be offloaded to a task."),
ECVF_RenderThreadSafe);
int32 GRDGParallelExecutePassMax = 32;
FAutoConsoleVariableRef CVarRDGParallelExecutePassMax(
TEXT("r.RDG.ParallelExecute.PassMax"), GRDGParallelExecutePassMax,
TEXT("The maximum span of contiguous passes eligible for parallel execution for the span to be offloaded to a task."),
ECVF_RenderThreadSafe);
// Fix for random GPU crashes on draw indirects on multiple IHVs. Force all indirect arg buffers as non transient (see UE-115982)
int32 GRDGTransientIndirectArgBuffers = 0;
FAutoConsoleVariableRef CVarRDGIndirectArgBufferTransientAllocated(
TEXT("r.RDG.TransientAllocator.IndirectArgumentBuffers"), GRDGTransientIndirectArgBuffers,
TEXT("Whether indirect argument buffers should use transient resource allocator. Default: 0"),
ECVF_RenderThreadSafe);
int32 GRDGParallelExecuteStress = 0;
FAutoConsoleVariableRef CVarRDGDebugParallelExecute(
TEXT("r.RDG.ParallelExecuteStress"),
GRDGParallelExecuteStress,
TEXT("Stress tests the parallel execution path by launching one task per pass. Render pass merging is also disabled."),
FConsoleVariableDelegate::CreateLambda([](IConsoleVariable* Variable)
{
static int32 GRDGMergeRenderPassesHistory = GRDGMergeRenderPasses;
static int32 GRDGParallelExecutePassMinHistory = GRDGParallelExecutePassMin;
static int32 GRDGParallelExecutePassMaxHistory = GRDGParallelExecutePassMax;
const int32 CurrentValue = Variable->GetInt();
if (GRDGParallelExecuteStress == CurrentValue)
{
return;
}
if (CurrentValue)
{
GRDGMergeRenderPassesHistory = GRDGMergeRenderPasses;
GRDGParallelExecutePassMinHistory = GRDGParallelExecutePassMin;
GRDGParallelExecutePassMaxHistory = GRDGParallelExecutePassMax;
GRDGMergeRenderPasses = 0;
GRDGParallelExecutePassMin = 1;
GRDGParallelExecutePassMax = 1;
}
else
{
GRDGMergeRenderPasses = GRDGMergeRenderPassesHistory;
GRDGParallelExecutePassMin = GRDGParallelExecutePassMinHistory;
GRDGParallelExecutePassMax = GRDGParallelExecutePassMaxHistory;
}
}),
ECVF_RenderThreadSafe);
#if CSV_PROFILER
int32 GRDGVerboseCSVStats = 0;
FAutoConsoleVariableRef CVarRDGVerboseCSVStats(
TEXT("r.RDG.VerboseCSVStats"),
GRDGVerboseCSVStats,
TEXT("Controls the verbosity of CSV profiling stats for RDG.\n")
TEXT(" 0: emits one CSV profile for graph execution;\n")
TEXT(" 1: emits a CSV profile for each phase of graph execution."),
ECVF_RenderThreadSafe);
#endif
#if STATS
int32 GRDGStatPassCount = 0;
int32 GRDGStatPassWithParameterCount = 0;
int32 GRDGStatPassCullCount = 0;
int32 GRDGStatPassDependencyCount = 0;
int32 GRDGStatRenderPassMergeCount = 0;
int32 GRDGStatTextureCount = 0;
int32 GRDGStatTextureReferenceCount = 0;
int32 GRDGStatBufferCount = 0;
int32 GRDGStatBufferReferenceCount = 0;
int32 GRDGStatViewCount = 0;
int32 GRDGStatTransientTextureCount = 0;
int32 GRDGStatTransientBufferCount = 0;
int32 GRDGStatTransitionCount = 0;
int32 GRDGStatAliasingCount = 0;
int32 GRDGStatTransitionBatchCount = 0;
int32 GRDGStatMemoryWatermark = 0;
DEFINE_STAT(STAT_RDG_PassCount);
DEFINE_STAT(STAT_RDG_PassWithParameterCount);
DEFINE_STAT(STAT_RDG_PassCullCount);
DEFINE_STAT(STAT_RDG_RenderPassMergeCount);
DEFINE_STAT(STAT_RDG_PassDependencyCount);
DEFINE_STAT(STAT_RDG_TextureCount);
DEFINE_STAT(STAT_RDG_TextureReferenceCount);
DEFINE_STAT(STAT_RDG_TextureReferenceAverage);
DEFINE_STAT(STAT_RDG_BufferCount);
DEFINE_STAT(STAT_RDG_BufferReferenceCount);
DEFINE_STAT(STAT_RDG_BufferReferenceAverage);
DEFINE_STAT(STAT_RDG_ViewCount);
DEFINE_STAT(STAT_RDG_TransientTextureCount);
DEFINE_STAT(STAT_RDG_TransientBufferCount);
DEFINE_STAT(STAT_RDG_TransitionCount);
DEFINE_STAT(STAT_RDG_AliasingCount);
DEFINE_STAT(STAT_RDG_TransitionBatchCount);
DEFINE_STAT(STAT_RDG_SetupTime);
DEFINE_STAT(STAT_RDG_CompileTime);
DEFINE_STAT(STAT_RDG_ExecuteTime);
DEFINE_STAT(STAT_RDG_CollectResourcesTime);
DEFINE_STAT(STAT_RDG_CollectBarriersTime);
DEFINE_STAT(STAT_RDG_ClearTime);
DEFINE_STAT(STAT_RDG_FlushRHIResources);
DEFINE_STAT(STAT_RDG_MemoryWatermark);
#endif
#if RDG_EVENTS != RDG_EVENTS_NONE
int32 GRDGEmitEvents = 0;
#endif
void InitRenderGraph()
{
#if RDG_ENABLE_DEBUG_WITH_ENGINE
if (FParse::Param(FCommandLine::Get(), TEXT("rdgimmediate")))
{
GRDGImmediateMode = 1;
}
if (FParse::Param(FCommandLine::Get(), TEXT("rdgdebug")))
{
GRDGDebug = 1;
}
if (FParse::Param(FCommandLine::Get(), TEXT("rdgdebugextendresourcelifetimes")))
{
GRDGDebugExtendResourceLifetimes = 1;
}
if (FParse::Param(FCommandLine::Get(), TEXT("rdgtransitionlog")))
{
// Set to -1 to specify infinite number of frames.
GRDGTransitionLog = -1;
}
int32 BreakpointValue = 0;
if (FParse::Value(FCommandLine::Get(), TEXT("rdgbreakpoint="), BreakpointValue))
{
GRDGBreakpoint = BreakpointValue;
}
if (FParse::Param(FCommandLine::Get(), TEXT("rdgclobberresources")))
{
GRDGClobberResources = 1;
}
int32 TransientAllocatorValue = 0;
if (FParse::Value(FCommandLine::Get(), TEXT("rdgtransientallocator="), TransientAllocatorValue))
{
GRDGTransientAllocator = TransientAllocatorValue;
}
int32 CullPassesValue = 0;
if (FParse::Value(FCommandLine::Get(), TEXT("rdgcullpasses="), CullPassesValue))
{
GRDGCullPasses = CullPassesValue;
}
int32 ParallelExecuteValue = 0;
if (FParse::Value(FCommandLine::Get(), TEXT("rdgparallelxecute="), ParallelExecuteValue))
{
GRDGParallelExecute = ParallelExecuteValue;
}
int32 MergeRenderPassesValue = 0;
if (FParse::Value(FCommandLine::Get(), TEXT("rdgmergerenderpasses="), MergeRenderPassesValue))
{
GRDGMergeRenderPasses = MergeRenderPassesValue;
}
int32 OverlapUAVsValue = 0;
if (FParse::Value(FCommandLine::Get(), TEXT("rdgoverlapuavs="), OverlapUAVsValue))
{
GRDGOverlapUAVs = OverlapUAVsValue;
}
int32 DumpGraphValue = 0;
if (FParse::Value(FCommandLine::Get(), TEXT("rdgdumpgraph="), DumpGraphValue))
{
CVarDumpGraph->Set(DumpGraphValue);
}
int32 AsyncComputeValue = 0;
if (FParse::Value(FCommandLine::Get(), TEXT("rdgasynccompute="), AsyncComputeValue))
{
CVarRDGAsyncCompute->Set(AsyncComputeValue);
}
FString GraphFilter;
if (FParse::Value(FCommandLine::Get(), TEXT("rdgdebuggraphfilter="), GraphFilter))
{
CVarRDGDebugGraphFilter->Set(*GraphFilter);
}
FString PassFilter;
if (FParse::Value(FCommandLine::Get(), TEXT("rdgdebugpassfilter="), PassFilter))
{
CVarRDGDebugPassFilter->Set(*PassFilter);
}
FString ResourceFilter;
if (FParse::Value(FCommandLine::Get(), TEXT("rdgdebugresourcefilter="), ResourceFilter))
{
CVarRDGDebugResourceFilter->Set(*ResourceFilter);
}
#endif
}