PipelineFileCache.cpp File Reference

#include "PipelineFileCache.h"
#include "Containers/List.h"
#include "Containers/Ticker.h"
#include "PipelineStateCache.h"
#include "HAL/IConsoleManager.h"
#include "Misc/EngineVersion.h"
#include "HAL/PlatformFile.h"
#include "Serialization/MemoryReader.h"
#include "Misc/CommandLine.h"
#include "Serialization/MemoryWriter.h"
#include "DataDrivenShaderPlatformInfo.h"
#include "Misc/ScopeRWLock.h"
#include "Misc/Paths.h"
#include "Async/AsyncFileHandle.h"
#include "HAL/PlatformFileManager.h"
#include "Misc/FileHelper.h"
#include "ProfilingDebugging/CsvProfiler.h"
#include "RHIStrings.h"
#include "String/LexFromString.h"
#include "String/ParseTokens.h"
#include "Misc/ScopeExit.h"
#include <Algo/ForEach.h>

Classes
struct	FPipelineCacheFileFormatHeader
struct	FPipelineCacheFileFormatPSOMetaData
struct	FPipelineCacheFileFormatTOC
class	FPipelineCacheFile
struct	FPipelineCacheFileData

Enumerations
enum class	EPipelineCacheFileFormatVersions : uint32 {   FirstWorking = 7 , LibraryID = 9 , ShaderMetaData = 10 , SortedVertexDesc = 11 ,   TOCMagicGuard = 12 , PSOUsageMask = 13 , PSOBindCount = 14 , EOFMarker = 15 ,   EngineFlags = 16 , Subpass = 17 , PatchSizeReduction_NoDuplicatedGuid = 18 , AlphaToCoverage = 19 ,   AddingMeshShaders = 20 , RemovingTessellationShaders = 21 , LastUsedTime = 22 , MoreRenderTargetFlags = 23 ,   FragmentDensityAttachment = 24 , AddingDepthClipMode = 25 , BeforeStableCacheVersioning = 26 , RemovingLineAA = 27 ,   AddingDepthBounds = 28 , AddRTPSOShaderBindingLayout = 29 , VariableRateShading = 30 }

Functions
	CSV_DEFINE_CATEGORY (PSO, true)
	DECLARE_DWORD_ACCUMULATOR_STAT (TEXT("Serialized Graphics Pipeline State Count"), STAT_SerializedGraphicsPipelineStateCount, STATGROUP_PipelineStateCache)
	DECLARE_DWORD_ACCUMULATOR_STAT (TEXT("Serialized Compute Pipeline State Count"), STAT_SerializedComputePipelineStateCount, STATGROUP_PipelineStateCache)
	DECLARE_DWORD_ACCUMULATOR_STAT (TEXT("Serialized RayTracing Pipeline State Count"), STAT_SerializedRayTracingPipelineStateCount, STATGROUP_PipelineStateCache)
	DECLARE_DWORD_ACCUMULATOR_STAT (TEXT("New Graphics Pipeline State Count"), STAT_NewGraphicsPipelineStateCount, STATGROUP_PipelineStateCache)
	DECLARE_DWORD_ACCUMULATOR_STAT (TEXT("New Compute Pipeline State Count"), STAT_NewComputePipelineStateCount, STATGROUP_PipelineStateCache)
	DECLARE_DWORD_ACCUMULATOR_STAT (TEXT("New RayTracing Pipeline State Count"), STAT_NewRayTracingPipelineStateCount, STATGROUP_PipelineStateCache)
	DECLARE_MEMORY_STAT (TEXT("New Cached PSO"), STAT_NewCachedPSOMemory, STATGROUP_PipelineStateCache)
	DECLARE_MEMORY_STAT (TEXT("PSO Stat"), STAT_PSOStatMemory, STATGROUP_PipelineStateCache)
	DECLARE_MEMORY_STAT (TEXT("File Cache"), STAT_FileCacheMemory, STATGROUP_PipelineStateCache)
void	LexFromString (ETextureCreateFlags &OutValue, const FStringView &InString)
bool	DefaultPSOMaskComparisonFunction (uint64 ReferenceMask, uint64 PSOMask)
FArchive &	operator<< (FArchive &Ar, FPipelineStateStats &Info)
RHI_API FArchive &	operator<< (FArchive &Ar, FPipelineFileCacheRasterizerState &RasterizerStateInitializer)
uint32	GetTypeHash (const FPipelineCacheFileFormatPSO &Key)
FArchive &	operator<< (FArchive &Ar, FPipelineCacheFileFormatPSO &Info)

Variables
const uint64	FPipelineCacheFileFormatMagic = 0x5049504543414348
const uint64	FPipelineCacheTOCFileFormatMagic = 0x544F435354415232
const uint64	FPipelineCacheEOFFileFormatMagic = 0x454F462D4D41524B
const RHI_API uint32	FPipelineCacheFileFormatCurrentVersion = (uint32)EPipelineCacheFileFormatVersions::AddRTPSOShaderBindingLayout
const int32	FPipelineCacheGraphicsDescPartsNum = 67
const uint16	FPipelineCacheFlagInvalidPSO = 1 << 0

Enumeration Type Documentation

EPipelineCacheFileFormatVersions

enum class EPipelineCacheFileFormatVersions : uint32

strong

Enumerator
FirstWorking
LibraryID
ShaderMetaData
SortedVertexDesc
TOCMagicGuard
PSOUsageMask
PSOBindCount
EOFMarker
EngineFlags
Subpass
PatchSizeReduction_NoDuplicatedGuid
AlphaToCoverage
AddingMeshShaders
RemovingTessellationShaders
LastUsedTime
MoreRenderTargetFlags
FragmentDensityAttachment
AddingDepthClipMode
BeforeStableCacheVersioning
RemovingLineAA
AddingDepthBounds
AddRTPSOShaderBindingLayout
VariableRateShading

Function Documentation

CSV_DEFINE_CATEGORY()

CSV_DEFINE_CATEGORY	(	PSO	,
		true
	)

DECLARE_DWORD_ACCUMULATOR_STAT() [1/6]

DECLARE_DWORD_ACCUMULATOR_STAT	(	TEXT("New Compute Pipeline State Count")	,
		STAT_NewComputePipelineStateCount	,
		STATGROUP_PipelineStateCache
	)

DECLARE_DWORD_ACCUMULATOR_STAT() [2/6]

DECLARE_DWORD_ACCUMULATOR_STAT	(	TEXT("New Graphics Pipeline State Count")	,
		STAT_NewGraphicsPipelineStateCount	,
		STATGROUP_PipelineStateCache
	)

DECLARE_DWORD_ACCUMULATOR_STAT() [3/6]

DECLARE_DWORD_ACCUMULATOR_STAT	(	TEXT("New RayTracing Pipeline State Count")	,
		STAT_NewRayTracingPipelineStateCount	,
		STATGROUP_PipelineStateCache
	)

DECLARE_DWORD_ACCUMULATOR_STAT() [4/6]

DECLARE_DWORD_ACCUMULATOR_STAT	(	TEXT("Serialized Compute Pipeline State Count")	,
		STAT_SerializedComputePipelineStateCount	,
		STATGROUP_PipelineStateCache
	)

DECLARE_DWORD_ACCUMULATOR_STAT() [5/6]

DECLARE_DWORD_ACCUMULATOR_STAT	(	TEXT("Serialized Graphics Pipeline State Count")	,
		STAT_SerializedGraphicsPipelineStateCount	,
		STATGROUP_PipelineStateCache
	)

DECLARE_DWORD_ACCUMULATOR_STAT() [6/6]

DECLARE_DWORD_ACCUMULATOR_STAT	(	TEXT("Serialized RayTracing Pipeline State Count")	,
		STAT_SerializedRayTracingPipelineStateCount	,
		STATGROUP_PipelineStateCache
	)

DECLARE_MEMORY_STAT() [1/3]

DECLARE_MEMORY_STAT	(	TEXT("File Cache")	,
		STAT_FileCacheMemory	,
		STATGROUP_PipelineStateCache
	)

DECLARE_MEMORY_STAT() [2/3]

DECLARE_MEMORY_STAT	(	TEXT("New Cached PSO")	,
		STAT_NewCachedPSOMemory	,
		STATGROUP_PipelineStateCache
	)

DECLARE_MEMORY_STAT() [3/3]

DECLARE_MEMORY_STAT	(	TEXT("PSO Stat")	,
		STAT_PSOStatMemory	,
		STATGROUP_PipelineStateCache
	)

DefaultPSOMaskComparisonFunction()

bool DefaultPSOMaskComparisonFunction	(	uint64	ReferenceMask,
		uint64	PSOMask
	)

GetTypeHash()

uint32 GetTypeHash

(

const FPipelineCacheFileFormatPSO &

Key

)

FPipelineCacheFileFormatPSO

LexFromString()

void LexFromString	(	ETextureCreateFlags &	OutValue,
		const FStringView &	InString
	)

operator<<() [1/3]

FArchive & operator<<	(	FArchive &	Ar,
		FPipelineCacheFileFormatPSO &	Info
	)

operator<<() [2/3]

RHI_API FArchive & operator<<	(	FArchive &	Ar,
		FPipelineFileCacheRasterizerState &	RasterizerStateInitializer
	)

operator<<() [3/3]

FArchive & operator<<	(	FArchive &	Ar,
		FPipelineStateStats &	Info
	)

Variable Documentation

FPipelineCacheEOFFileFormatMagic

const uint64 FPipelineCacheEOFFileFormatMagic = 0x454F462D4D41524B

FPipelineCacheFileFormatCurrentVersion

const RHI_API uint32 FPipelineCacheFileFormatCurrentVersion = (uint32)EPipelineCacheFileFormatVersions::AddRTPSOShaderBindingLayout

FPipelineCacheFileFormatMagic

const uint64 FPipelineCacheFileFormatMagic = 0x5049504543414348

FPipelineCacheFlagInvalidPSO

const uint16 FPipelineCacheFlagInvalidPSO = 1 << 0

PipelineFileCache MetaData Engine Flags

FPipelineCacheGraphicsDescPartsNum

const int32 FPipelineCacheGraphicsDescPartsNum = 67

FPipelineCacheTOCFileFormatMagic

const uint64 FPipelineCacheTOCFileFormatMagic = 0x544F435354415232