// Copyright Epic Games, Inc. All Rights Reserved. #include "ShaderFormatD3D.h" #include "ShaderPreprocessor.h" #include "ShaderCompilerCommon.h" #include "ShaderMinifier.h" #include "ShaderParameterParser.h" #include "D3D12RHI.h" #include "Misc/Paths.h" #include "Misc/FileHelper.h" #include "HAL/FileManager.h" #include "Serialization/MemoryWriter.h" #include "RayTracingDefinitions.h" #include "SpirvCommon.h" DEFINE_LOG_CATEGORY_STATIC(LogD3D11ShaderCompiler, Log, All); #define DEBUG_SHADERS 0 // D3D doesn't define a mask for this, so we do so here #define SHADER_OPTIMIZATION_LEVEL_MASK (D3DCOMPILE_OPTIMIZATION_LEVEL0 | D3DCOMPILE_OPTIMIZATION_LEVEL1 | D3DCOMPILE_OPTIMIZATION_LEVEL2 | D3DCOMPILE_OPTIMIZATION_LEVEL3) // Disable macro redefinition warning for compatibility with Windows SDK 8+ #pragma warning(push) #pragma warning(disable : 4005) // macro redefinition #include "Windows/AllowWindowsPlatformTypes.h" #include #include #include #include "Windows/HideWindowsPlatformTypes.h" #undef DrawText #include "D3DShaderCompiler.inl" #pragma warning(pop) static const uint32 GD3DMaximumNumUAVs = 8; // Limit for feature level 11.0 static int32 GD3DCheckForDoubles = 1; static int32 GD3DDumpAMDCodeXLFile = 0; /** * TranslateCompilerFlag - translates the platform-independent compiler flags into D3DX defines * @param CompilerFlag - the platform-independent compiler flag to translate * @return uint32 - the value of the appropriate D3DX enum */ static uint32 TranslateCompilerFlagD3D11(ECompilerFlags CompilerFlag) { switch(CompilerFlag) { case CFLAG_PreferFlowControl: return D3DCOMPILE_PREFER_FLOW_CONTROL; case CFLAG_AvoidFlowControl: return D3DCOMPILE_AVOID_FLOW_CONTROL; case CFLAG_WarningsAsErrors: return D3DCOMPILE_WARNINGS_ARE_ERRORS; default: return 0; }; } /** * Filters out unwanted shader compile warnings */ static void D3D11FilterShaderCompileWarnings(const FString& CompileWarnings, TArray& FilteredWarnings) { TArray WarningArray; FString OutWarningString = TEXT(""); CompileWarnings.ParseIntoArray(WarningArray, TEXT("\n"), true); //go through each warning line for (int32 WarningIndex = 0; WarningIndex < WarningArray.Num(); WarningIndex++) { //suppress "warning X3557: Loop only executes for 1 iteration(s), forcing loop to unroll" if (!WarningArray[WarningIndex].Contains(TEXT("X3557")) // "warning X3205: conversion from larger type to smaller, possible loss of data" // Gets spammed when converting from float to half && !WarningArray[WarningIndex].Contains(TEXT("X3205"))) { FilteredWarnings.AddUnique(WarningArray[WarningIndex]); } } } // @return 0 if not recognized static const TCHAR* GetShaderProfileName(ELanguage Language, uint32 Frequency, bool bForceSM6) { if (Language == ELanguage::SM6 || IsRayTracingShaderFrequency(EShaderFrequency(Frequency))) { switch (Frequency) { default: checkfSlow(false, TEXT("Unexpected shader frequency")); return nullptr; case SF_Pixel: return USE_SHADER_MODEL_6_6 ? TEXT("ps_6_6") : TEXT("ps_6_5"); case SF_Vertex: return USE_SHADER_MODEL_6_6 ? TEXT("vs_6_6") : TEXT("vs_6_5"); case SF_Mesh: return USE_SHADER_MODEL_6_6 ? TEXT("ms_6_6") : TEXT("ms_6_5"); case SF_Amplification: return USE_SHADER_MODEL_6_6 ? TEXT("as_6_6") : TEXT("as_6_5"); case SF_Geometry: return USE_SHADER_MODEL_6_6 ? TEXT("gs_6_6") : TEXT("gs_6_5"); case SF_Compute: return USE_SHADER_MODEL_6_6 ? TEXT("cs_6_6") : TEXT("cs_6_5"); case SF_RayGen: case SF_RayMiss: case SF_RayHitGroup: case SF_RayCallable: return USE_SHADER_MODEL_6_6 ? TEXT("lib_6_6") : TEXT("lib_6_5"); } } else if(Language == ELanguage::SM5) { //set defines and profiles for the appropriate shader paths switch(Frequency) { default: checkfSlow(false, TEXT("Unexpected shader frequency")); return nullptr; case SF_Pixel: return bForceSM6 ? TEXT("ps_6_0") : TEXT("ps_5_0"); case SF_Vertex: return bForceSM6 ? TEXT("vs_6_0") : TEXT("vs_5_0"); case SF_Geometry: return bForceSM6 ? TEXT("gs_6_0") : TEXT("gs_5_0"); case SF_Compute: return bForceSM6 ? TEXT("cs_6_0") : TEXT("cs_5_0"); case SF_RayGen: case SF_RayMiss: case SF_RayHitGroup: case SF_RayCallable: checkNoEntry(); return TEXT("lib_6_5"); } } else if (Language == ELanguage::ES3_1) { checkSlow(Frequency == SF_Vertex || Frequency == SF_Pixel || Frequency == SF_Geometry || Frequency == SF_Compute); //set defines and profiles for the appropriate shader paths switch(Frequency) { case SF_Pixel: return bForceSM6 ? TEXT("ps_6_0") : TEXT("ps_5_0"); case SF_Vertex: return bForceSM6 ? TEXT("vs_6_0") : TEXT("vs_5_0"); case SF_Geometry: return bForceSM6 ? TEXT("gs_6_0") : TEXT("gs_5_0"); case SF_Compute: return bForceSM6 ? TEXT("cs_6_0") : TEXT("cs_5_0"); } } return nullptr; } /** * D3D11CreateShaderCompileCommandLine - takes shader parameters used to compile with the DX11 * compiler and returns an fxc command to compile from the command line */ static FString D3D11CreateShaderCompileCommandLine( const FString& ShaderPath, const TCHAR* EntryFunction, const TCHAR* ShaderProfile, uint32 CompileFlags, FShaderCompilerOutput& Output ) { // fxc is our command line compiler FString FXCCommandline = FString(TEXT("%FXC% ")) + ShaderPath; // add the entry point reference FXCCommandline += FString(TEXT(" /E ")) + EntryFunction; // go through and add other switches if(CompileFlags & D3DCOMPILE_PREFER_FLOW_CONTROL) { CompileFlags &= ~D3DCOMPILE_PREFER_FLOW_CONTROL; FXCCommandline += FString(TEXT(" /Gfp")); } if(CompileFlags & D3DCOMPILE_DEBUG) { CompileFlags &= ~D3DCOMPILE_DEBUG; FXCCommandline += FString(TEXT(" /Zi")); } if(CompileFlags & D3DCOMPILE_SKIP_OPTIMIZATION) { CompileFlags &= ~D3DCOMPILE_SKIP_OPTIMIZATION; FXCCommandline += FString(TEXT(" /Od")); } if (CompileFlags & D3DCOMPILE_SKIP_VALIDATION) { CompileFlags &= ~D3DCOMPILE_SKIP_VALIDATION; FXCCommandline += FString(TEXT(" /Vd")); } if(CompileFlags & D3DCOMPILE_AVOID_FLOW_CONTROL) { CompileFlags &= ~D3DCOMPILE_AVOID_FLOW_CONTROL; FXCCommandline += FString(TEXT(" /Gfa")); } if(CompileFlags & D3DCOMPILE_PACK_MATRIX_ROW_MAJOR) { CompileFlags &= ~D3DCOMPILE_PACK_MATRIX_ROW_MAJOR; FXCCommandline += FString(TEXT(" /Zpr")); } if(CompileFlags & D3DCOMPILE_ENABLE_BACKWARDS_COMPATIBILITY) { CompileFlags &= ~D3DCOMPILE_ENABLE_BACKWARDS_COMPATIBILITY; FXCCommandline += FString(TEXT(" /Gec")); } if (CompileFlags & D3DCOMPILE_WARNINGS_ARE_ERRORS) { CompileFlags &= ~D3DCOMPILE_WARNINGS_ARE_ERRORS; FXCCommandline += FString(TEXT(" /WX")); } switch (CompileFlags & SHADER_OPTIMIZATION_LEVEL_MASK) { case D3DCOMPILE_OPTIMIZATION_LEVEL2: CompileFlags &= ~D3DCOMPILE_OPTIMIZATION_LEVEL2; FXCCommandline += FString(TEXT(" /O2")); break; case D3DCOMPILE_OPTIMIZATION_LEVEL3: CompileFlags &= ~D3DCOMPILE_OPTIMIZATION_LEVEL3; FXCCommandline += FString(TEXT(" /O3")); break; case D3DCOMPILE_OPTIMIZATION_LEVEL1: CompileFlags &= ~D3DCOMPILE_OPTIMIZATION_LEVEL1; FXCCommandline += FString(TEXT(" /O1")); break; case D3DCOMPILE_OPTIMIZATION_LEVEL0: CompileFlags &= ~D3DCOMPILE_OPTIMIZATION_LEVEL0; break; default: Output.Errors.Emplace(TEXT("Unknown D3DCOMPILE optimization level")); break; } checkf(CompileFlags == 0, TEXT("Unhandled d3d11 shader compiler flag!")); // add the target instruction set FXCCommandline += FString(TEXT(" /T ")) + ShaderProfile; // Assembly instruction numbering FXCCommandline += TEXT(" /Ni"); // Output to ShaderPath.d3dasm if (FPaths::GetExtension(ShaderPath) == TEXT("usf")) { FXCCommandline += FString::Printf(TEXT(" /Fc%sd3dasm"), *ShaderPath.LeftChop(3)); } // add a pause on a newline FXCCommandline += FString(TEXT(" \r\n pause")); // Batch file header: /* @ECHO OFF SET FXC="C:\Program Files (x86)\Windows Kits\10\bin\x64\fxc.exe" IF EXIST %FXC% ( REM ) ELSE ( ECHO Couldn't find Windows 10 SDK, falling back to DXSDK... SET FXC="%DXSDK_DIR%\Utilities\bin\x86\fxc.exe" IF EXIST %FXC% ( REM ) ELSE ( ECHO Couldn't find DXSDK! Exiting... GOTO END ) ) */ const FString BatchFileHeader = TEXT( "@ECHO OFF\n"\ "IF \"%FXC%\" == \"\" SET FXC=\"C:\\Program Files (x86)\\Windows Kits\\10\\bin\\x64\\fxc.exe\"\n"\ "IF NOT EXIST %FXC% (\n"\ "\tECHO Couldn't find Windows 10 SDK, falling back to DXSDK...\n"\ "\tSET FXC=\"%DXSDK_DIR%\\Utilities\\bin\\x86\\fxc.exe\"\n"\ "\tIF NOT EXIST % FXC % (\n"\ "\t\tECHO Couldn't find DXSDK! Exiting...\n"\ "\t\tGOTO END\n"\ "\t)\n"\ ")\n" ); return BatchFileHeader + FXCCommandline + TEXT("\n:END\nREM\n"); } // Validate that we are not going over to maximum amount of resource bindings support by the default root signature on DX12 // Currently limited for hard-coded root signature setup (see: FD3D12Adapter::StaticGraphicsRootSignature) // In theory this limitation is only required for DX12, but we don't want a shader to compile on DX11 while not working on DX12. // (DX11 has an API limit on 128 SRVs, 16 Samplers, 8 UAVs and 14 CBs but if you go over these values then the shader won't compile) bool ValidateResourceCounts(uint32 NumSRVs, uint32 NumSamplers, uint32 NumUAVs, uint32 NumCBs, TArray& OutFilteredErrors) { if (NumSRVs > MAX_SRVS || NumSamplers > MAX_SAMPLERS || NumUAVs > MAX_UAVS || NumCBs > MAX_CBS) { if (NumSRVs > MAX_SRVS) { OutFilteredErrors.Add(FString::Printf(TEXT("Shader is using too many SRVs: %d (only %d supported)"), NumSRVs, MAX_SRVS)); } if (NumSamplers > MAX_SAMPLERS) { OutFilteredErrors.Add(FString::Printf(TEXT("Shader is using too many Samplers: %d (only %d supported)"), NumSamplers, MAX_SAMPLERS)); } if (NumUAVs > MAX_UAVS) { OutFilteredErrors.Add(FString::Printf(TEXT("Shader is using too many UAVs: %d (only %d supported)"), NumUAVs, MAX_UAVS)); } if (NumCBs > MAX_CBS) { OutFilteredErrors.Add(FString::Printf(TEXT("Shader is using too many Constant Buffers: %d (only %d supported)"), NumCBs, MAX_CBS)); } return false; } return true; } /** Creates a batch file string to call the AMD shader analyzer. */ static FString CreateAMDCodeXLCommandLine( const FString& ShaderPath, const TCHAR* EntryFunction, const TCHAR* ShaderProfile, uint32 DXFlags ) { // Hardcoded to the default install path since there's no Env variable or addition to PATH FString Commandline = FString(TEXT("\"C:\\Program Files (x86)\\AMD\\CodeXL\\CodeXLAnalyzer.exe\" -c Pitcairn")) + TEXT(" -f ") + EntryFunction + TEXT(" -s HLSL") + TEXT(" -p ") + ShaderProfile + TEXT(" -a AnalyzerStats.csv") + TEXT(" --isa ISA.txt") + *FString::Printf(TEXT(" --DXFlags %u "), DXFlags) + ShaderPath; // add a pause on a newline Commandline += FString(TEXT(" \r\n pause")); return Commandline; } // D3Dcompiler.h has function pointer typedefs for some functions, but not all typedef HRESULT(WINAPI *pD3DReflect) (__in_bcount(SrcDataSize) LPCVOID pSrcData, __in SIZE_T SrcDataSize, __in REFIID pInterface, __out void** ppReflector); typedef HRESULT(WINAPI *pD3DStripShader) (__in_bcount(BytecodeLength) LPCVOID pShaderBytecode, __in SIZE_T BytecodeLength, __in UINT uStripFlags, __out ID3DBlob** ppStrippedBlob); #define DEFINE_GUID_FOR_CURRENT_COMPILER(name, l, w1, w2, b1, b2, b3, b4, b5, b6, b7, b8) \ static const GUID name = { l, w1, w2, { b1, b2, b3, b4, b5, b6, b7, b8 } } // ShaderReflection IIDs may change between SDK versions if the reflection API changes. // Define a GUID below that matches the desired IID for the DLL in CompilerPath. For example, // look for IID_ID3D11ShaderReflection in d3d11shader.h for the SDK matching the compiler DLL. DEFINE_GUID_FOR_CURRENT_COMPILER(IID_ID3D11ShaderReflectionForCurrentCompiler, 0x8d536ca1, 0x0cca, 0x4956, 0xa8, 0x37, 0x78, 0x69, 0x63, 0x75, 0x55, 0x84); // Helper class to load the engine-packaged FXC DLL and retrieve function pointers for the various FXC functions from it. class FxcCompilerFunctions { public: static pD3DCompile GetCompile() { return Instance().Compile; } static pD3DReflect GetReflect() { return Instance().Reflect; } static pD3DDisassemble GetDisassemble() { return Instance().Disassemble; } static pD3DStripShader GetStripShader() { return Instance().StripShader; } private: FxcCompilerFunctions() { FString CompilerPath = FPaths::EngineDir() / TEXT("Binaries/ThirdParty/Windows/DirectX/x64/d3dcompiler_47.dll"); CompilerDLL = LoadLibrary(*CompilerPath); if (!CompilerDLL) { UE_LOG(LogD3D11ShaderCompiler, Fatal, TEXT("Cannot find the compiler DLL '%s'"), *CompilerPath); } Compile = (pD3DCompile)(void*)GetProcAddress(CompilerDLL, "D3DCompile"); Reflect = (pD3DReflect)(void*)GetProcAddress(CompilerDLL, "D3DReflect"); Disassemble = (pD3DDisassemble)(void*)GetProcAddress(CompilerDLL, "D3DDisassemble"); StripShader = (pD3DStripShader)(void*)GetProcAddress(CompilerDLL, "D3DStripShader"); } static FxcCompilerFunctions& Instance() { static FxcCompilerFunctions Instance; return Instance; } HMODULE CompilerDLL = 0; pD3DCompile Compile = nullptr; pD3DReflect Reflect = nullptr; pD3DDisassemble Disassemble = nullptr; pD3DStripShader StripShader = nullptr; }; static int D3DExceptionFilter(bool bCatchException) { return bCatchException ? EXCEPTION_EXECUTE_HANDLER : EXCEPTION_CONTINUE_SEARCH; } static HRESULT D3DCompileWrapper( pD3DCompile D3DCompileFunc, LPCVOID pSrcData, SIZE_T SrcDataSize, LPCSTR pFileName, CONST D3D_SHADER_MACRO* pDefines, ID3DInclude* pInclude, LPCSTR pEntrypoint, LPCSTR pTarget, uint32 Flags1, uint32 Flags2, ID3DBlob** ppCode, ID3DBlob** ppErrorMsgs, bool bCatchException = false ) { #if !PLATFORM_SEH_EXCEPTIONS_DISABLED __try #endif { return D3DCompileFunc( pSrcData, SrcDataSize, pFileName, pDefines, pInclude, pEntrypoint, pTarget, Flags1, Flags2, ppCode, ppErrorMsgs ); } #if !PLATFORM_SEH_EXCEPTIONS_DISABLED __except(D3DExceptionFilter(bCatchException)) { FSCWErrorCode::Report(FSCWErrorCode::CrashInsidePlatformCompiler); return E_FAIL; } #endif } inline bool IsCompatibleBinding(const D3D11_SHADER_INPUT_BIND_DESC& BindDesc, uint32 BindingSpace) { return true; } static void PatchSpirvForPrecompilation(FSpirv& Spirv) { // Remove [unroll] loop hints from SPIR-V as this can fail on infinite loops for (FSpirvIterator SpirvInstruction : Spirv) { if (SpirvInstruction.Opcode() == SpvOpLoopMerge && SpirvInstruction.Operand(3) == SpvLoopControlUnrollMask) { (*SpirvInstruction)[3] = SpvLoopControlMaskNone; } } } // @todo-lh: use ANSI string class whenever UE core gets one static void PatchHlslForPrecompilation(TArray& HlslSource) { FString HlslSourceString; // Disable some warnings that might be introduced by cross-compiled HLSL, we only want to see those warnings from the original source and not from intermediate high-level source HlslSourceString += TEXT("#pragma warning(disable : 3571) // pow() intrinsic suggested to be used with abs()\n"); // Append original cross-compiled source code HlslSourceString += ANSI_TO_TCHAR(HlslSource.GetData()); // Patch SPIRV-Cross renaming to retain original member names in RootShaderParameters cbuffer const int32 RootShaderParameterSourceLocation = HlslSourceString.Find("cbuffer RootShaderParameters"); if (RootShaderParameterSourceLocation != INDEX_NONE) { HlslSourceString.ReplaceInline(TEXT("cbuffer RootShaderParameters"), TEXT("cbuffer _RootShaderParameters"), ESearchCase::CaseSensitive); HlslSourceString.ReplaceInline(TEXT("_RootShaderParameters_"), TEXT(""), ESearchCase::CaseSensitive); } // Patch separation of atomic counters: replace declarations of all counter_var_... declarations by their original buffer resource. const FString CounterPrefix = TEXT("counter_var_"); const FString CounterDeclPrefix = TEXT("RWByteAddressBuffer ") + CounterPrefix; for (int32 ReadPos = 0, NextReadPos = 0; (NextReadPos = HlslSourceString.Find(CounterDeclPrefix, ESearchCase::CaseSensitive, ESearchDir::FromStart, ReadPos)) != INDEX_NONE; ReadPos = NextReadPos) { // Find original resource name without "counter_var_" prefix const int32 ResourceNameStartPos = NextReadPos + CounterDeclPrefix.Len(); const int32 ResourceNameEndPos = HlslSourceString.Find(TEXT(";"), ESearchCase::CaseSensitive, ESearchDir::FromStart, ResourceNameStartPos); if (ResourceNameEndPos != INDEX_NONE) { const FString ResourceName = HlslSourceString.Mid(NextReadPos + CounterDeclPrefix.Len(), ResourceNameEndPos - ResourceNameStartPos); const FString ResourceCounterName = HlslSourceString.Mid(NextReadPos + CounterDeclPrefix.Len() - CounterPrefix.Len(), ResourceNameEndPos - ResourceNameStartPos + CounterPrefix.Len()); // Remove current "RWByteAddressBuffer counter_var_*;" resource declaration line HlslSourceString.RemoveAt(NextReadPos, ResourceNameEndPos - NextReadPos + 1); // Remove all "counter_var_" prefixes for the current resource HlslSourceString.ReplaceInline(*ResourceCounterName, *ResourceName, ESearchCase::CaseSensitive); } } // Return new HLSL source HlslSource.SetNum(HlslSourceString.Len() + 1); FMemory::Memcpy(HlslSource.GetData(), TCHAR_TO_ANSI(*HlslSourceString), HlslSourceString.Len()); HlslSource[HlslSourceString.Len()] = '\0'; } // Returns whether the specified D3D compiler error buffer contains any internal error messages, e.g. "internal error: out of memory" static bool CompileErrorsContainInternalError(ID3DBlob* Errors) { if (Errors) { if (void* ErrorBuffer = Errors->GetBufferPointer()) { const ANSICHAR* ErrorString = reinterpret_cast(ErrorBuffer); return FCStringAnsi::Strstr(ErrorString, "internal error:") != nullptr || FCStringAnsi::Strstr(ErrorString, "Internal Compiler Error:") != nullptr; } } return false; } // Generate the dumped usf file; call the D3D compiler, gather reflection information and generate the output data static bool CompileAndProcessD3DShaderFXCExt( FString& PreprocessedShaderSource, uint32 CompileFlags, const FShaderCompilerInput& Input, const FShaderParameterParser& ShaderParameterParser, FString& EntryPointName, const TCHAR* ShaderProfile, bool bSecondPassAferUnusedInputRemoval, TArray& FilteredErrors, FShaderCompilerOutput& Output) { TRACE_CPUPROFILER_EVENT_SCOPE(CompileAndProcessD3DShaderFXCExt); auto AnsiSourceFile = StringCast(*PreprocessedShaderSource); // Write out the preprocessed file and a batch file to compile it if requested (DumpDebugInfoPath is valid) UE::ShaderCompilerCommon::DumpDebugShaderData(Input, PreprocessedShaderSource); bool bDumpDebugInfo = Input.DumpDebugInfoEnabled(); FString DisasmFilename; if (bDumpDebugInfo) { FString BatchFileContents; FString Filename = Input.GetSourceFilename(); BatchFileContents = D3D11CreateShaderCompileCommandLine(Filename, *EntryPointName, ShaderProfile, CompileFlags, Output); if (GD3DDumpAMDCodeXLFile) { const FString BatchFileContents2 = CreateAMDCodeXLCommandLine(Filename, *EntryPointName, ShaderProfile, CompileFlags); FFileHelper::SaveStringToFile(BatchFileContents2, *(Input.DumpDebugInfoPath / TEXT("CompileAMD.bat"))); } FFileHelper::SaveStringToFile(BatchFileContents, *(Input.DumpDebugInfoPath / TEXT("CompileFXC.bat"))); DisasmFilename = *(Input.DumpDebugInfoPath / TEXT("Output.d3dasm")); } TRefCountPtr Shader; HRESULT Result = S_OK; pD3DCompile D3DCompileFunc = FxcCompilerFunctions::GetCompile(); pD3DReflect D3DReflectFunc = FxcCompilerFunctions::GetReflect(); pD3DDisassemble D3DDisassembleFunc = FxcCompilerFunctions::GetDisassemble(); pD3DStripShader D3DStripShaderFunc = FxcCompilerFunctions::GetStripShader(); TRefCountPtr Errors; if (D3DCompileFunc) { const bool bHlslVersion2021 = Input.Environment.CompilerFlags.Contains(CFLAG_HLSL2021); const bool bPrecompileWithDXC = bHlslVersion2021 || Input.Environment.CompilerFlags.Contains(CFLAG_PrecompileWithDXC); if (!bPrecompileWithDXC) { Result = D3DCompileWrapper( D3DCompileFunc, AnsiSourceFile.Get(), AnsiSourceFile.Length(), TCHAR_TO_ANSI(*Input.VirtualSourceFilePath), /*pDefines=*/ NULL, /*pInclude=*/ NULL, TCHAR_TO_ANSI(*EntryPointName), TCHAR_TO_ANSI(ShaderProfile), CompileFlags, 0, Shader.GetInitReference(), Errors.GetInitReference(), // We only want to catch the exception on initial FXC compiles so we can retry with a // DXC precompilation step. If it fails again on the second attempt then we let // ShaderCompileWorker handle the exception and log an error. /* bCatchException */ true ); } // Some materials give FXC a hard time to optimize and the compiler fails with an internal error. if (bPrecompileWithDXC || Result == HRESULT_FROM_WIN32(ERROR_ARITHMETIC_OVERFLOW) || Result == E_OUTOFMEMORY || Result == E_FAIL || (Result != S_OK && CompileErrorsContainInternalError(Errors.GetReference()))) { // If we ran out of memory, it's likely the next attempt will crash, too. // Report the error now in case CompileHlslToSpirv throws an exception. if (Result == E_OUTOFMEMORY) { FSCWErrorCode::Report(FSCWErrorCode::OutOfMemory); } CrossCompiler::FShaderConductorContext CompilerContext; // Load shader source into compiler context const EShaderFrequency Frequency = (EShaderFrequency)Input.Target.Frequency; CompilerContext.LoadSource(PreprocessedShaderSource, Input.VirtualSourceFilePath, EntryPointName, Frequency); // Compile HLSL source to SPIR-V binary CrossCompiler::FShaderConductorOptions Options; if (bHlslVersion2021) { Options.HlslVersion = 2021; } FSpirv Spirv; if (!CompilerContext.CompileHlslToSpirv(Options, Spirv.Data)) { CompilerContext.FlushErrors(Output.Errors); return false; } // Cross-compile back to HLSL CrossCompiler::FShaderConductorTarget TargetDesc; TargetDesc.Language = CrossCompiler::EShaderConductorLanguage::Hlsl; TargetDesc.Version = 50; TargetDesc.CompileFlags.SetDefine(TEXT("implicit_resource_binding"), 1); TargetDesc.CompileFlags.SetDefine(TEXT("reconstruct_global_uniforms"), 1); TargetDesc.CompileFlags.SetDefine(TEXT("reconstruct_cbuffer_names"), 1); TargetDesc.CompileFlags.SetDefine(TEXT("reconstruct_semantics"), 1); TargetDesc.CompileFlags.SetDefine(TEXT("force_zero_initialized_variables"), 1); // Patch SPIR-V for workarounds to prevent potential additional FXC failures PatchSpirvForPrecompilation(Spirv); TArray CrossCompiledSource; if (!CompilerContext.CompileSpirvToSourceAnsi(Options, TargetDesc, Spirv.GetByteData(), Spirv.GetByteSize(), CrossCompiledSource)) { CompilerContext.FlushErrors(Output.Errors); return false; } // Patch HLSL for workarounds to prevent potential additional FXC failures PatchHlslForPrecompilation(CrossCompiledSource); if (bDumpDebugInfo && CrossCompiledSource.Num() > 1) { DumpDebugShaderDisassembledSpirv(Input, Spirv.GetByteData(), Spirv.GetByteSize(), TEXT("intermediate.spvasm")); DumpDebugShaderText(Input, CrossCompiledSource.GetData(), CrossCompiledSource.Num() - 1, TEXT("intermediate.hlsl")); } // Compile again with FXC: // SPIRV-Cross will have generated the new shader with "main" as the new entry point. const FString CrossCompiledSourceFilename = Input.VirtualSourceFilePath + TEXT(".intermediate.hlsl"); Result = D3DCompileWrapper( D3DCompileFunc, CrossCompiledSource.GetData(), CrossCompiledSource.Num() - 1, TCHAR_TO_ANSI(*CrossCompiledSourceFilename), /*pDefines=*/ NULL, /*pInclude=*/ NULL, "main", TCHAR_TO_ANSI(ShaderProfile), CompileFlags & (~D3DCOMPILE_WARNINGS_ARE_ERRORS), 0, Shader.GetInitReference(), Errors.GetInitReference() ); if (!bPrecompileWithDXC && SUCCEEDED(Result)) { // Reset our previously set error code FSCWErrorCode::Reset(); // Let the user know this shader had to be cross-compiled due to a crash in FXC. Only shows up if CVar 'r.ShaderDevelopmentMode' is enabled. Output.Errors.Add(FShaderCompilerError(FString::Printf(TEXT("Cross-compiled shader to intermediate HLSL after first attempt crashed FXC: %s"), *Input.GenerateShaderName()))); } } } else { FilteredErrors.Add(TEXT("Couldn't find D3D shader compiler DLL")); Result = E_FAIL; } // Filter any errors. void* ErrorBuffer = Errors ? Errors->GetBufferPointer() : NULL; if (ErrorBuffer) { D3D11FilterShaderCompileWarnings(ANSI_TO_TCHAR(ErrorBuffer), FilteredErrors); } // Fail the compilation if certain extended features are being used, since those are not supported on all D3D11 cards. if (SUCCEEDED(Result) && D3DDisassembleFunc) { const bool bCheckForTypedUAVs = !Input.Environment.CompilerFlags.Contains(CFLAG_AllowTypedUAVLoads); if (GD3DCheckForDoubles || bCheckForTypedUAVs || bDumpDebugInfo) { TRefCountPtr Disassembly; if (SUCCEEDED(D3DDisassembleFunc(Shader->GetBufferPointer(), Shader->GetBufferSize(), 0, "", Disassembly.GetInitReference()))) { ANSICHAR* DisassemblyString = new ANSICHAR[Disassembly->GetBufferSize() + 1]; FMemory::Memcpy(DisassemblyString, Disassembly->GetBufferPointer(), Disassembly->GetBufferSize()); DisassemblyString[Disassembly->GetBufferSize()] = 0; FString DisassemblyStringW(DisassemblyString); delete[] DisassemblyString; if (bDumpDebugInfo) { FFileHelper::SaveStringToFile(DisassemblyStringW, *(Input.DumpDebugInfoPath / TEXT("Output.d3dasm"))); } if (GD3DCheckForDoubles) { // dcl_globalFlags will contain enableDoublePrecisionFloatOps when the shader uses doubles, even though the docs on dcl_globalFlags don't say anything about this if (DisassemblyStringW.Contains(TEXT("enableDoublePrecisionFloatOps"))) { FilteredErrors.Add(TEXT("Shader uses double precision floats, which are not supported on all D3D11 hardware!")); return false; } } if (bCheckForTypedUAVs) { // Disassembly will contain this text with typed loads from UAVs are used where the format and dimension are not fully supported // across all versions of Windows (like Windows 7/8.1). // https://microsoft.github.io/DirectX-Specs/d3d/UAVTypedLoad.html // https://docs.microsoft.com/en-us/windows/win32/direct3d12/typed-unordered-access-view-loads // https://docs.microsoft.com/en-us/windows/win32/direct3ddxgi/format-support-for-direct3d-11-0-feature-level-hardware if (DisassemblyStringW.Contains(TEXT("Typed UAV Load Additional Formats"))) { FilteredErrors.Add(TEXT("Shader uses UAV loads from additional typed formats, which are not supported on all D3D11 hardware! Set r.D3D.CheckedForTypedUAVs=0 if you want to allow typed UAV loads for your project, or individual shaders can opt-in by specifying CFLAG_AllowTypedUAVLoads.")); return false; } } } } } // Gather reflection information TArray ShaderInputs; TArray VendorExtensions; if (SUCCEEDED(Result)) { bool bGlobalUniformBufferUsed = false; bool bDiagnosticBufferUsed = false; uint32 NumInstructions = 0; uint32 NumSamplers = 0; uint32 NumSRVs = 0; uint32 NumCBs = 0; uint32 NumUAVs = 0; TArray UniformBufferNames; TBitArray<> UsedUniformBufferSlots; UsedUniformBufferSlots.Init(false, 32); if (D3DReflectFunc) { Output.bSucceeded = true; ID3D11ShaderReflection* Reflector = NULL; Result = D3DReflectFunc(Shader->GetBufferPointer(), Shader->GetBufferSize(), IID_ID3D11ShaderReflectionForCurrentCompiler, (void**)&Reflector); if (FAILED(Result)) { UE_LOG(LogD3D11ShaderCompiler, Fatal, TEXT("D3DReflect failed: Result=%08x"), Result); } // Read the constant table description. D3D11_SHADER_DESC ShaderDesc; Reflector->GetDesc(&ShaderDesc); if (Input.Target.Frequency == SF_Pixel) { bool bFoundUnused = false; for (uint32 Index = 0; Index < ShaderDesc.InputParameters; ++Index) { // VC++ horrible hack: Runtime ESP checks get confused and fail for some reason calling Reflector->GetInputParameterDesc() (because it comes from another DLL?) // so "guard it" using the middle of an array; it's been confirmed NO corruption is really happening. D3D11_SIGNATURE_PARAMETER_DESC ParamDescs[3]; D3D11_SIGNATURE_PARAMETER_DESC& ParamDesc = ParamDescs[1]; Reflector->GetInputParameterDesc(Index, &ParamDesc); if (ParamDesc.SystemValueType == D3D_NAME_UNDEFINED) { if (ParamDesc.ReadWriteMask != 0) { FString SemanticName = ANSI_TO_TCHAR(ParamDesc.SemanticName); ShaderInputs.AddUnique(SemanticName); // Add the number (for the case of TEXCOORD) FString SemanticIndexName = FString::Printf(TEXT("%s%d"), *SemanticName, ParamDesc.SemanticIndex); ShaderInputs.AddUnique(SemanticIndexName); // Add _centroid ShaderInputs.AddUnique(SemanticName + TEXT("_centroid")); ShaderInputs.AddUnique(SemanticIndexName + TEXT("_centroid")); } else { bFoundUnused = true; } } else { //if (ParamDesc.ReadWriteMask != 0) { // Keep system values ShaderInputs.AddUnique(FString(ANSI_TO_TCHAR(ParamDesc.SemanticName))); } } } if (Input.Environment.CompilerFlags.Contains(CFLAG_ForceRemoveUnusedInterpolators) && Input.bCompilingForShaderPipeline && bFoundUnused && !bSecondPassAferUnusedInputRemoval) { // Rewrite the source removing the unused inputs so the bindings will match. // We may need to do this more than once if unused inputs change after the removal. Ie. for complex shaders, what can happen is: // pass1 detects that input A is not used, but input B and C are. Input A is removed, and we recompile (pass2). After the recompilation, we see that Input B is now also unused in pass2 // (it became simpler and the compiler could see through that). // Since unused inputs are passed to the next stage, that will cause us to generate a vertex shader that does not output B, but our pixel shader will still be expecting B on input, // as it was rewritten based on the pass1 results. FString OriginalPreprocSource = PreprocessedShaderSource; FString OriginalEntryPointName = EntryPointName; FShaderCompilerOutput OriginalOutput = Output; const int kMaxReasonableAttempts = 64; for (int32 Attempt = 0; Attempt < kMaxReasonableAttempts; ++Attempt) { TArray RemoveErrors; PreprocessedShaderSource = OriginalPreprocSource; EntryPointName = OriginalEntryPointName; if (RemoveUnusedInputs(PreprocessedShaderSource, ShaderInputs, EntryPointName, RemoveErrors)) { Output = OriginalOutput; if (!CompileAndProcessD3DShaderFXCExt(PreprocessedShaderSource, CompileFlags, Input, ShaderParameterParser, EntryPointName, ShaderProfile, true, FilteredErrors, Output)) { // if we failed to compile the shader, propagate the error up return false; } // check if the ShaderInputs changed - if not, we're done here if (Output.UsedAttributes.Num() == ShaderInputs.Num()) { return true; } // second pass cannot use more attributes than previously if (Output.UsedAttributes.Num() > ShaderInputs.Num()) { UE_LOG(LogD3D11ShaderCompiler, Warning, TEXT("Second pass had more used attributes (%d) than first pass (%d)"), Output.UsedAttributes.Num(), ShaderInputs.Num()); FShaderCompilerError NewError; NewError.StrippedErrorMessage = FString::Printf(TEXT("Second pass had more used attributes (%d) than first pass (%d)"), Output.UsedAttributes.Num(), ShaderInputs.Num()); Output = OriginalOutput; Output.Errors.Add(NewError); break; } // if we're about to run out of attempts, report if (Attempt >= kMaxReasonableAttempts - 1) { UE_LOG(LogD3D11ShaderCompiler, Warning, TEXT("Unable to determine unused inputs after %d attempts (last number of used attributes: %d, previous step:%d)!"), Attempt + 1, Output.UsedAttributes.Num(), ShaderInputs.Num() ); FShaderCompilerError NewError; NewError.StrippedErrorMessage = FString::Printf(TEXT("Unable to determine unused inputs after %d attempts (last number of used attributes: %d, previous step:%d)!"), Attempt + 1, Output.UsedAttributes.Num(), ShaderInputs.Num() ); Output = OriginalOutput; Output.Errors.Add(NewError); break; } ShaderInputs = Output.UsedAttributes; // go around to remove newly identified unused inputs } else { UE_LOG(LogD3D11ShaderCompiler, Warning, TEXT("Failed to remove unused inputs from shader: %s"), *Input.GenerateShaderName()); for (const FString& ErrorMessage : RemoveErrors) { // Add error to shader output but also make sure the error shows up on build farm by emitting a log entry UE_LOG(LogD3D11ShaderCompiler, Warning, TEXT("%s"), *ErrorMessage); FShaderCompilerError NewError; NewError.StrippedErrorMessage = ErrorMessage; Output.Errors.Add(NewError); } break; } } } } const uint32 BindingSpace = 0; // Default binding space for D3D11 shaders ExtractParameterMapFromD3DShader< ID3D11ShaderReflection, D3D11_SHADER_DESC, D3D11_SHADER_INPUT_BIND_DESC, ID3D11ShaderReflectionConstantBuffer, D3D11_SHADER_BUFFER_DESC, ID3D11ShaderReflectionVariable, D3D11_SHADER_VARIABLE_DESC>( Input, ShaderParameterParser, BindingSpace, Reflector, ShaderDesc, bGlobalUniformBufferUsed, bDiagnosticBufferUsed, NumSamplers, NumSRVs, NumCBs, NumUAVs, Output, UniformBufferNames, UsedUniformBufferSlots, VendorExtensions); NumInstructions = ShaderDesc.InstructionCount; // Reflector is a com interface, so it needs to be released. Reflector->Release(); } else { FilteredErrors.Add(TEXT("Couldn't find shader reflection function in D3D Compiler DLL")); Result = E_FAIL; Output.bSucceeded = false; } if (!ValidateResourceCounts(NumSRVs, NumSamplers, NumUAVs, NumCBs, FilteredErrors)) { Result = E_FAIL; Output.bSucceeded = false; } // Check for resource limits for feature level 11.0 if (NumUAVs > GD3DMaximumNumUAVs) { FilteredErrors.Add(FString::Printf(TEXT("Number of UAVs exceeded limit: %d slots used, but limit is %d due to maximum feature level 11.0"), NumUAVs, GD3DMaximumNumUAVs)); Result = E_FAIL; Output.bSucceeded = false; } // Save results if compilation and reflection succeeded if (Output.bSucceeded) { TRefCountPtr CompressedData; if (Input.Environment.CompilerFlags.Contains(CFLAG_GenerateSymbols)) { CompressedData = Shader; } else if (D3DStripShaderFunc) { // Strip shader reflection and debug info D3D_SHADER_DATA ShaderData; ShaderData.pBytecode = Shader->GetBufferPointer(); ShaderData.BytecodeLength = Shader->GetBufferSize(); Result = D3DStripShaderFunc(Shader->GetBufferPointer(), Shader->GetBufferSize(), D3DCOMPILER_STRIP_REFLECTION_DATA | D3DCOMPILER_STRIP_DEBUG_INFO | D3DCOMPILER_STRIP_TEST_BLOBS, CompressedData.GetInitReference()); if (FAILED(Result)) { UE_LOG(LogD3D11ShaderCompiler, Fatal, TEXT("D3DStripShader failed: Result=%08x"), Result); } } else { // D3DStripShader is not guaranteed to exist // e.g. the open-source DXIL shader compiler does not currently implement it CompressedData = Shader; } // Add resource masks before the parameters are pulled for the uniform buffers FShaderCodeResourceMasks ResourceMasks{}; for (const auto& Param : Output.ParameterMap.GetParameterMap()) { const FParameterAllocation& ParamAlloc = Param.Value; if (ParamAlloc.Type == EShaderParameterType::UAV) { ResourceMasks.UAVMask |= 1u << ParamAlloc.BaseIndex; } } auto AddOptionalDataCallback = [&](FShaderCode& ShaderCode) { Output.ShaderCode.AddOptionalData(ResourceMasks); }; FShaderCodePackedResourceCounts PackedResourceCounts{}; if (bGlobalUniformBufferUsed) { PackedResourceCounts.UsageFlags |= EShaderResourceUsageFlags::GlobalUniformBuffer; } PackedResourceCounts.NumSamplers = static_cast(NumSamplers); PackedResourceCounts.NumSRVs = static_cast(NumSRVs); PackedResourceCounts.NumCBs = static_cast(NumCBs); PackedResourceCounts.NumUAVs = static_cast(NumUAVs); GenerateFinalOutput(CompressedData, Input, VendorExtensions, UsedUniformBufferSlots, UniformBufferNames, bSecondPassAferUnusedInputRemoval, ShaderInputs, PackedResourceCounts, NumInstructions, Output, [](FMemoryWriter&){}, AddOptionalDataCallback); } } return SUCCEEDED(Result); } bool CompileAndProcessD3DShaderFXC(FString& PreprocessedShaderSource, uint32 CompileFlags, const FShaderCompilerInput& Input, const FShaderParameterParser& ShaderParameterParser, FString& EntryPointName, const TCHAR* ShaderProfile, bool bSecondPassAferUnusedInputRemoval, FShaderCompilerOutput& Output) { TArray FilteredErrors; const bool bSuccess = CompileAndProcessD3DShaderFXCExt(PreprocessedShaderSource, CompileFlags, Input, ShaderParameterParser, EntryPointName, ShaderProfile, false, FilteredErrors, Output); // Process errors for (int32 ErrorIndex = 0; ErrorIndex < FilteredErrors.Num(); ErrorIndex++) { const FString& CurrentError = FilteredErrors[ErrorIndex]; FShaderCompilerError NewError; // Extract filename and line number from FXC output with format: // "d:\Project\Binaries\BasePassPixelShader(30,7): error X3000: invalid target or usage string" int32 FirstParenIndex = CurrentError.Find(TEXT("(")); int32 LastParenIndex = CurrentError.Find(TEXT("):")); if (FirstParenIndex != INDEX_NONE && LastParenIndex != INDEX_NONE && LastParenIndex > FirstParenIndex) { // Extract and store error message with source filename NewError.ErrorVirtualFilePath = CurrentError.Left(FirstParenIndex); NewError.ErrorLineString = CurrentError.Mid(FirstParenIndex + 1, LastParenIndex - FirstParenIndex - FCString::Strlen(TEXT("("))); NewError.StrippedErrorMessage = CurrentError.Right(CurrentError.Len() - LastParenIndex - FCString::Strlen(TEXT("):"))); } else { NewError.StrippedErrorMessage = CurrentError; } Output.Errors.Add(NewError); } return bSuccess; } void CompileD3DShader(const FShaderCompilerInput& Input, FShaderCompilerOutput& Output, FShaderCompilerDefinitions& AdditionalDefines, const FString& WorkingDirectory, ELanguage Language) { TRACE_CPUPROFILER_EVENT_SCOPE(CompileD3DShader); FString PreprocessedShaderSource; const bool bUseDXC = !Input.CanCompileWithLegacyFxc(); const TCHAR* ShaderProfile = GetShaderProfileName(Language, Input.Target.Frequency, bUseDXC); if(!ShaderProfile) { Output.Errors.Add(FShaderCompilerError(*FString::Printf(TEXT("Unrecognized shader frequency %s"), GetShaderFrequencyString((EShaderFrequency)Input.Target.Frequency)))); return; } // Set additional defines. AdditionalDefines.SetDefine(TEXT("COMPILER_HLSL"), 1); AdditionalDefines.SetDefine(TEXT("PLATFORM_SUPPORTS_ROV"), 1); // Assume min. spec HW supports with DX12/SM5 if (bUseDXC) { AdditionalDefines.SetDefine(TEXT("PLATFORM_SUPPORTS_CALLABLE_SHADERS"), 1); AdditionalDefines.SetDefine(TEXT("PLATFORM_SUPPORTS_SM6_0_WAVE_OPERATIONS"), 1); AdditionalDefines.SetDefine(TEXT("PLATFORM_SUPPORTS_STATIC_SAMPLERS"), 1); AdditionalDefines.SetDefine(TEXT("PLATFORM_SUPPORTS_DIAGNOSTIC_BUFFER"), 1); AdditionalDefines.SetDefine(TEXT("COMPILER_SUPPORTS_NOINLINE"), 1); if (Input.Environment.CompilerFlags.Contains(CFLAG_InlineRayTracing)) { AdditionalDefines.SetDefine(TEXT("PLATFORM_SUPPORTS_INLINE_RAY_TRACING"), 1); } if (Language == ELanguage::SM6 && Input.Environment.CompilerFlags.Contains(CFLAG_AllowRealTypes)) { AdditionalDefines.SetDefine(TEXT("PLATFORM_SUPPORTS_REAL_TYPES"), 1); } } const double StartPreprocessTime = FPlatformTime::Seconds(); if (Input.bSkipPreprocessedCache) { if (!FFileHelper::LoadFileToString(PreprocessedShaderSource, *Input.VirtualSourceFilePath)) { return; } // Remove const as we are on debug-only mode CrossCompiler::CreateEnvironmentFromResourceTable(PreprocessedShaderSource, (FShaderCompilerEnvironment&)Input.Environment); } else { if (!PreprocessShader(PreprocessedShaderSource, Output, Input, AdditionalDefines)) { // The preprocessing stage will add any relevant errors. return; } } FString EntryPointName = Input.EntryPointName; if (Input.Environment.CompilerFlags.Contains(CFLAG_ForceRemoveUnusedInterpolators) && Input.Target.Frequency == SF_Vertex && Input.bCompilingForShaderPipeline) { // Always add SV_Position TArray UsedOutputs = Input.UsedOutputs; UsedOutputs.AddUnique(TEXT("SV_POSITION")); UsedOutputs.AddUnique(TEXT("SV_ViewPortArrayIndex")); // We can't remove any of the output-only system semantics //@todo - there are a bunch of tessellation ones as well TArray Exceptions; Exceptions.AddUnique(TEXT("SV_ClipDistance")); Exceptions.AddUnique(TEXT("SV_ClipDistance0")); Exceptions.AddUnique(TEXT("SV_ClipDistance1")); Exceptions.AddUnique(TEXT("SV_ClipDistance2")); Exceptions.AddUnique(TEXT("SV_ClipDistance3")); Exceptions.AddUnique(TEXT("SV_ClipDistance4")); Exceptions.AddUnique(TEXT("SV_ClipDistance5")); Exceptions.AddUnique(TEXT("SV_ClipDistance6")); Exceptions.AddUnique(TEXT("SV_ClipDistance7")); Exceptions.AddUnique(TEXT("SV_CullDistance")); Exceptions.AddUnique(TEXT("SV_CullDistance0")); Exceptions.AddUnique(TEXT("SV_CullDistance1")); Exceptions.AddUnique(TEXT("SV_CullDistance2")); Exceptions.AddUnique(TEXT("SV_CullDistance3")); Exceptions.AddUnique(TEXT("SV_CullDistance4")); Exceptions.AddUnique(TEXT("SV_CullDistance5")); Exceptions.AddUnique(TEXT("SV_CullDistance6")); Exceptions.AddUnique(TEXT("SV_CullDistance7")); // Write the preprocessed file out in case so we can debug issues on HlslParser UE::ShaderCompilerCommon::DumpDebugShaderData(Input, PreprocessedShaderSource); TArray Errors; if (!RemoveUnusedOutputs(PreprocessedShaderSource, UsedOutputs, Exceptions, EntryPointName, Errors)) { UE_LOG(LogD3D11ShaderCompiler, Warning, TEXT("Failed to remove unused outputs from shader: %s"), *Input.GenerateShaderName()); for (const FString& ErrorReport : Errors) { // Add error to shader output but also make sure the error shows up on build farm by emitting a log entry UE_LOG(LogD3D11ShaderCompiler, Warning, TEXT("%s"), *ErrorReport); FShaderCompilerError NewError; NewError.StrippedErrorMessage = ErrorReport; Output.Errors.Add(NewError); } } } FShaderParameterParser ShaderParameterParser(TEXT("cbuffer")); if (!ShaderParameterParser.ParseAndModify(Input, Output, PreprocessedShaderSource)) { // The FShaderParameterParser will add any relevant errors. return; } // Only use UniformBuffer structs on SM6 until we can fully vet SM5 if (Language != ELanguage::SM6) { RemoveUniformBuffersFromSource(Input.Environment, PreprocessedShaderSource); } // Process TEXT macro. TransformStringIntoCharacterArray(PreprocessedShaderSource); Output.PreprocessTime = FPlatformTime::Seconds() - StartPreprocessTime; TArray FilteredErrors; // Run the shader minifier #if UE_D3D_SHADER_COMPILER_ALLOW_DEAD_CODE_REMOVAL if (Input.Environment.CompilerFlags.Contains(CFLAG_RemoveDeadCode)) { UE::ShaderCompilerCommon::RemoveDeadCode(PreprocessedShaderSource, EntryPointName, Output.Errors); } #endif // UE_D3D_SHADER_COMPILER_ALLOW_DEAD_CODE_REMOVAL // @TODO - implement different material path to allow us to remove backwards compat flag on sm5 shaders uint32 CompileFlags = D3DCOMPILE_ENABLE_BACKWARDS_COMPATIBILITY // Unpack uniform matrices as row-major to match the CPU layout. | D3DCOMPILE_PACK_MATRIX_ROW_MAJOR; if (Input.Environment.CompilerFlags.Contains(CFLAG_GenerateSymbols)) { CompileFlags |= D3DCOMPILE_DEBUG; } if (Input.Environment.CompilerFlags.Contains(CFLAG_Debug)) { CompileFlags |= D3DCOMPILE_SKIP_OPTIMIZATION; } else { if (Input.Environment.CompilerFlags.Contains(CFLAG_StandardOptimization)) { CompileFlags |= D3DCOMPILE_OPTIMIZATION_LEVEL1; } else { CompileFlags |= D3DCOMPILE_OPTIMIZATION_LEVEL3; } } Input.Environment.CompilerFlags.Iterate([&CompileFlags](uint32 Flag) { CompileFlags |= TranslateCompilerFlagD3D11((ECompilerFlags)Flag); }); const bool bSuccess = bUseDXC ? CompileAndProcessD3DShaderDXC(PreprocessedShaderSource, CompileFlags, Input, ShaderParameterParser, EntryPointName, ShaderProfile, Language, false, Output) : CompileAndProcessD3DShaderFXC(PreprocessedShaderSource, CompileFlags, Input, ShaderParameterParser, EntryPointName, ShaderProfile, false, Output); if (!bSuccess && !Output.Errors.Num()) { Output.Errors.Add(TEXT("Compile failed without errors!")); } const bool bDirectCompile = FParse::Param(FCommandLine::Get(), TEXT("directcompile")); if (bDirectCompile) { for (const auto& Error : Output.Errors) { FPlatformMisc::LowLevelOutputDebugStringf(TEXT("%s\n"), *Error.GetErrorStringWithLineMarker()); } } ShaderParameterParser.ValidateShaderParameterTypes(Input, Output); if (Input.ExtraSettings.bExtractShaderSource) { Output.OptionalFinalShaderSource = PreprocessedShaderSource; } } void CompileShader_Windows(const FShaderCompilerInput& Input,FShaderCompilerOutput& Output,const FString& WorkingDirectory, ELanguage Language) { FShaderCompilerDefinitions AdditionalDefines; if (Language == ELanguage::SM6) { AdditionalDefines.SetDefine(TEXT("SM6_PROFILE"), 1); } else if (Language == ELanguage::SM5) { AdditionalDefines.SetDefine(TEXT("SM5_PROFILE"), 1); } else if (Language == ELanguage::ES3_1) { AdditionalDefines.SetDefine(TEXT("ES3_1_PROFILE"), 1); } else { checkf(0, TEXT("Unknown ELanguage %d"), (int32)Language); } CompileD3DShader(Input, Output, AdditionalDefines, WorkingDirectory, Language); }