Utilisation de DXC.exe et de l'interface .dll dxcompiler

dxc_<version>\dxc.exe
dxc_<version>\dxcompiler.dll
dxc_<version>\dxcapi.h
dxc_<version>\d3d12shader.h
dxc_<version>\dxcompiler.lib

Microsoft GDK\<Version>\GXDK\bin\XboxOne\dxc.exe
Microsoft GDK\<Version>\GXDK\bin\XboxOne\dxcompiler_x.dll
Microsoft GDK\<Version>\GXDK\toolKit\Include\XboxOne\dxcapi_x.h
Microsoft GDK\<Version>\GXDK\toolKit\Include\XboxOne\d3d12shader_x.h
Microsoft GDK\<Version>\GXDK\toolKit\lib\amd64\XboxOne\dxcompiler_x.lib

Microsoft GDK\<Version>\GXDK\gameKit\Include\XboxOne\dxcapi_x.h
Microsoft GDK\<Version>\GXDK\gameKit\Include\XboxOne\d3d12shader_x.h
Microsoft GDK\<Version>\GXDK\gameKit\lib\amd64\XboxOne\dxcompiler_x.lib

Microsoft GDK\<Version>\GXDK\bin\Scarlett\dxc.exe
Microsoft GDK\<Version>\GXDK\bin\Scarlett\dxcompiler_xs.dll
Microsoft GDK\<Version>\GXDK\toolKit\Include\Scarlett\dxcapi_xs.h
Microsoft GDK\<Version>\GXDK\toolKit\Include\Scarlett\d3d12shader_xs.h
Microsoft GDK\<Version>\GXDK\toolKit\lib\amd64\Scarlett\dxcompiler_xs.lib

Microsoft GDK\<Version>\GXDK\gameKit\Include\Scarlett\dxcapi_xs.h
Microsoft GDK\<Version>\GXDK\gameKit\Include\Scarlett\d3d12shader_xs.h
Microsoft GDK\<Version>\GXDK\gameKit\lib\amd64\Scarlett\dxcompiler_xs.lib

-D <value>              Define macro.
-E <value>              Entry point name.
-Fd <file>              Write debug information to the specified file or directory; trail \ to autogenerate.
-Fo <file>              Output object file.
-Gec                    Enable backward compatibility mode.
-HV <value>             HLSL version (2016, 2017, 2018). Default is 2018.
-Od                     Disable optimizations.
-T <profile>            Set target profile.
    <profile>: ps_6_0, ps_6_1, ps_6_2, ps_6_3, ps_6_4,
                vs_6_0, vs_6_1, vs_6_2, vs_6_3, vs_6_4,
                cs_6_0, cs_6_1, cs_6_2, cs_6_3, cs_6_4,
                gs_6_0, gs_6_1, gs_6_2, gs_6_3, gs_6_4,
                ds_6_0, ds_6_1, ds_6_2, ds_6_3, ds_6_4,
                hs_6_0, hs_6_1, hs_6_2, hs_6_3, hs_6_4,
                lib_6_3, lib_6_4
-Vd                     Disable validation.
-Zi                     Enable debug information.
-Zpc                    Pack matrices in column-major order.
-Zpr                    Pack matrices in row-major order.

dxc -E main -T ps_6_0 -Fo myshader.bin -Zi -Fd myshader.pdb -D MYDEFINE=1 myshader.hlsl

SetDefaultDllDirectories(LOAD_LIBRARY_SEARCH_DEFAULT_DIRS);

const WCHAR* szWindowCompilerPath =   L"C:\\LatestDxcCompiler";
const WCHAR* szXboxCompilerPath =     L"C:\\Program Files (x86)\\Microsoft GDK\\191100\\GXDK\\bin\\XboxOne";
const WCHAR* szScarlettCompilerPath = L"C:\\Program Files (x86)\\Microsoft GDK\\191100\\GXDK\\bin\\Scarlett";

// Make sure .dll dependencies are handled correctly.
AddDllDirectory(szWindowCompilerPath);
AddDllDirectory(szXboxCompilerPath);
AddDllDirectory(szScarlettCompilerPath);

// Load the .dlls.
HMODULE hModuleDxcWindows = LoadLibraryEx(L"dxcompiler.dll", NULL, 0);
HMODULE hModuleDxcXbox = LoadLibraryEx(L"dxcompiler_x.dll", NULL, 0);
HMODULE hModuleDxcScarlett = LoadLibraryEx(L"dxcompiler_xs.dll", NULL, 0);

// Get the create interface functions for each platform.
decltype(&DxcCreateInstance) m_pfnDxcCreateInstanceWindows = (decltype(&DxcCreateInstance))GetProcAddress(hModuleDxcWindows, "DxcCreateInstance");
decltype(&DxcCreateInstance) m_pfnDxcCreateInstanceXbox = (decltype(&DxcCreateInstance))GetProcAddress(hModuleDxcXbox, "DxcCreateInstance");
decltype(&DxcCreateInstance) m_pfnDxcCreateInstanceScarlett = (decltype(&DxcCreateInstance))GetProcAddress(hModuleDxcScarlett, "DxcCreateInstance");

#include <atlbase.h>        // Common COM helpers.
#include <dxcapi_x.h>       // Be sure to link with dxcompiler_x.lib.
#include <d3d12shader_x.h>  // Shader reflection.

int main()
{
    // 
    // Create compiler and utils.
    //
    CComPtr<IDxcUtils> pUtils;
    CComPtr<IDxcCompiler3> pCompiler;
    DxcCreateInstance(CLSID_DxcUtils, IID_PPV_ARGS(&pUtils));
    DxcCreateInstance(CLSID_DxcCompiler, IID_PPV_ARGS(&pCompiler));

    //
    // Create default include handler. (You can create your own...)
    //
    CComPtr<IDxcIncludeHandler> pIncludeHandler;
    pUtils->CreateDefaultIncludeHandler(&pIncludeHandler);


    //
    // COMMAND LINE: dxc myshader.hlsl -E main -T ps_6_0 -Zs -D MYDEFINE=1 -Fo myshader.bin -Fd myshader.pdb -D __XBOX_STRIP_DXIL -Qstrip_reflect
    //
   LPCWSTR pszArgs[] =
    {
        L"myshader.hlsl",            // Optional shader source file name for error reporting and for PIX shader source view.  
        L"-E", L"main",              // Entry point.
        L"-T", L"ps_6_0",            // Target.
        L"-Zs",                      // Enable smaller debug information.
        L"-D", L"MYDEFINE=1",        // A single define.
        L"-Fo", L"myshader.bin",     // Optional. Stored in the pdb. 
        L"-Fd", L"myshader.pdb",     // The file name of the pdb. This must either be supplied or the autogenerated file name must be used.
        L"-D", L"__XBOX_STRIP_DXIL", // Strip DXIL.
        L"-Qstrip_reflect",          // Strip reflection into a separate blob. 
    };


    //
    // Open source file.  
    //
    CComPtr<IDxcBlobEncoding> pSource = nullptr;
    pUtils->LoadFile(L"myshader.hlsl", nullptr, &pSource);
    DxcBuffer Source;
    Source.Ptr = pSource->GetBufferPointer();
    Source.Size = pSource->GetBufferSize();
    Source.Encoding = DXC_CP_ACP; // Assume BOM says UTF8 or UTF16 or this is ANSI text.


    //
    // Compile it with specified arguments.
    //
    CComPtr<IDxcResult> pResults;
    pCompiler->Compile(
        &Source,                // Source buffer.
        pszArgs,                // Array of pointers to arguments.
        _countof(pszArgs),      // Number of arguments.
        pIncludeHandler,        // User-provided interface to handle #include directives (optional).
        IID_PPV_ARGS(&pResults) // Compiler output status, buffer, and errors.
    );

    //
    // Print errors if present.
    //
    CComPtr<IDxcBlobUtf8> pErrors = nullptr;
    pResults->GetOutput(DXC_OUT_ERRORS, IID_PPV_ARGS(&pErrors), nullptr);
    // Note that d3dcompiler would return null if no errors or warnings are present.  
    // IDxcCompiler3::Compile will always return an error buffer, but its length will be zero if there are no warnings or errors.
    if (pErrors != nullptr && pErrors->GetStringLength() != 0)
        wprintf(L"Warnings and Errors:\n%S\n", pErrors->GetStringPointer());

    //
    // Quit if the compilation failed.
    //
    HRESULT hrStatus;
    pResults->GetStatus(&hrStatus);
    if (FAILED(hrStatus))
    {
        wprintf(L"Compilation Failed\n");
        return 1;
    }

    //
    // Save shader binary.
    //
    CComPtr<IDxcBlob> pShader = nullptr;
    CComPtr<IDxcBlobUtf16> pShaderName = nullptr;
    pResults->GetOutput(DXC_OUT_OBJECT, IID_PPV_ARGS(&pShader), &pShaderName);
    if (pShader != nullptr)
    {
        FILE* fp = NULL;

        _wfopen_s(&fp, pShaderName->GetStringPointer(), L"wb");
        fwrite(pShader->GetBufferPointer(), pShader->GetBufferSize(), 1, fp);
        fclose(fp);
    }

    //
    // Save pdb.
    //
    CComPtr<IDxcBlob> pPDB = nullptr;
    CComPtr<IDxcBlobUtf16> pPDBName = nullptr;
    pResults->GetOutput(DXC_OUT_PDB, IID_PPV_ARGS(&pPDB), &pPDBName);
    {
        FILE* fp = NULL;

        // Note that if you don't specify -Fd, a pdb name will be automatically generated. Use this file name to save the pdb so that PIX can find it quickly.
        _wfopen_s(&fp, pPDBName->GetStringPointer(), L"wb");
        fwrite(pPDB->GetBufferPointer(), pPDB->GetBufferSize(), 1, fp);
        fclose(fp);
    }

    //
    // Print hash.
    //
    CComPtr<IDxcBlob> pHash = nullptr;
    pResults->GetOutput(DXC_OUT_SHADER_HASH, IID_PPV_ARGS(&pHash), nullptr);
    if (pHash != nullptr)
    {
        wprintf(L"Hash: ");
        DxcShaderHash* pHashBuf = (DxcShaderHash*)pHash->GetBufferPointer();
        for (int i = 0; i < _countof(pHashBuf->HashDigest); i++)
            wprintf(L"%x", pHashBuf->HashDigest[i]);
        wprintf(L"\n");
    }


    //
    // Get separate reflection.
    //
    CComPtr<IDxcBlob> pReflectionData;
    pResults->GetOutput(DXC_OUT_REFLECTION, IID_PPV_ARGS(&pReflectionData), nullptr);
    if (pReflectionData != nullptr)
    {
        // Optionally, save reflection blob for later here.

        // Create reflection interface.
        DxcBuffer ReflectionData;
        ReflectionData.Encoding = DXC_CP_ACP;
        ReflectionData.Ptr = pReflectionData->GetBufferPointer();
        ReflectionData.Size = pReflectionData->GetBufferSize();

        CComPtr< ID3D12ShaderReflection > pReflection;
        pUtils->CreateReflection(&ReflectionData, IID_PPV_ARGS(&pReflection));

        // Use reflection interface here.
        
    }

    return 0;
}

HRESULT STDMETHODCALLTYPE MyAllocator::QueryInterface(REFIID iid, void** ppvObject) override
{
    if (ppvObject == nullptr)
    {
        return E_POINTER;
    }
    *ppvObject = nullptr;

    if (IsEqualIID(iid, IID_IMalloc) || IsEqualIID(iid, IID_IUnknown)) {
        *ppvObject = reinterpret_cast<void*>(this);
        AddRef();
        return S_OK;
    }

    return E_NOINTERFACE;
}

void PrintXboxShaderStats(IDxcBlob* pProgram)
{
    // load shader into Xbox container
    CComPtr<IDxcXboxContainer> pContainer;
    DxcCreateInstance(CLSID_DxcXboxContainer, __uuidof(IDxcXboxContainer), (void **)&pContainer);
    pContainer->Load(pProgram);

    // get hardware stage count
    UINT32 Count = 0;
    pContainer->GetNumShaders(&Count);

    for (UINT32 i = 0; i < Count; i++)
    {
        // get hardware shader stage interface
        CComPtr<IDxcXboxHwShader> hwShader;
        pContainer->GetShader(i, __uuidof(IDxcXboxHwShader), (void **)&hwShader);

        // get hardware stage name
        CComPtr<IDxcBlobUtf8> pStageName;
        hwShader->GetStageName(&pStageName);
        const char* szStageName = pStageName->GetStringPointer();

        // get hardware stage stats
        CComPtr<IDxcBlob> pStats;
        hwShader->GetShaderStats(DxcXboxShaderStatsClass::V1, 0, &pStats);
        DxcXboxShaderStaticsV1 stats;
        memcpy(&stats, pStats->GetBufferPointer(), sizeof(stats));

        // print stats
        printf("State Name: %s\n", szStageName);
        printf("NumVGPRs: %u\n", (UINT)stats.NumVGPR);
        printf("NumSGPRs: %u\n", (UINT)stats.NumSGPR);
        printf("WaveSize: %u\n", (UINT)stats.WaveSize);
        printf("Occupancy: %u\n", (UINT)stats.Occupancy);
        printf("ThreadGroupWaveCount: %u\n", (UINT)stats.ThreadGroupWaveCount);
        printf("LDSSizeInBytes: %u\n", (UINT)stats.LDSSizeInBytes);
        printf("PerLaneScratchSizeInBytes %u\n", (UINT)stats.PerLaneScratchSizeInBytes);
    }
}