ShaderCompileWorkerUtil.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "ShaderCompilerJobTypes.h"
#include "Containers/Array.h"
 
class FArchive;
 
struct FSCWErrorCode
{
    enum ECode : int32
    {
        NotSet = -1,
        Success,
        GeneralCrash,
        BadShaderFormatVersion,
        BadInputVersion,
        BadSingleJobHeader,
        BadPipelineJobHeader,
        CantDeleteInputFile,
        CantSaveOutputFile,
        NoTargetShaderFormatsFound,
        CantCompileForSpecificFormat,
        CrashInsidePlatformCompiler,
        BadInputFile,
        OutOfMemory,
    };
 
    static RENDERCORE_API void Report(ECode Code, const FStringView& Info = {});
 
    static RENDERCORE_API void Reset();
 
    static RENDERCORE_API ECode Get();
 
    static RENDERCORE_API const FString& GetInfo();
 
    static RENDERCORE_API bool IsSet();
};
 
class FShaderCompileWorkerUtil
{
public:
    enum class EWriteTasksFlags : uint8
    {
        None = 0,
        CompressTaskFile = 1 << 0,
        SkipSource = 1 << 1,
    };
 
    enum class EReadTasksFlags : uint8
    {
        None = 0,
        WillRetry = 1 << 0,
    };
 
    RENDERCORE_API static void LogQueuedCompileJobs(const TArray<FShaderCommonCompileJobPtr>& QueuedJobs, int32 NumProcessedJobs);
    RENDERCORE_API static void DumpDebugCompileInput(FShaderCommonCompileJob& Job, FShaderDebugDataContext& Ctx);
    RENDERCORE_API static bool WriteTasks(const TArray<FShaderCommonCompileJobPtr>& QueuedJobs, FArchive& TransferFile, EWriteTasksFlags Flags = EWriteTasksFlags::None);
    RENDERCORE_API static FSCWErrorCode::ECode ReadTasks(const TArray<FShaderCommonCompileJobPtr>& QueuedJobs, FArchive& OutputFile, FShaderCompileWorkerDiagnostics* OutWorkerDiagnostics, EReadTasksFlags Flags = EReadTasksFlags::None);
 
private:
    static bool HandleWorkerCrash(
        const TArray<FShaderCommonCompileJobPtr>& QueuedJobs,
        FArchive& OutputFile,
        int32 OutputVersion,
        int64 FileSize,
        FSCWErrorCode::ECode ErrorCode,
        int32 NumProcessedJobs,
        int32 CallstackLength,
        int32 ExceptionInfoLength,
        int32 HostnameLength,
        bool bWillRetry);
};
 
ENUM_CLASS_FLAGS(FShaderCompileWorkerUtil::EWriteTasksFlags);
ENUM_CLASS_FLAGS(FShaderCompileWorkerUtil::EReadTasksFlags);