Build instruction

[wenxcs]

Dependency:

1. DirectX Shader Compiler: for dxil codegen, we use customized repo - https://github.com/nnfusion/DirectXShaderCompiler. In this repo's wenxh/enable_reflection_blob_in_linux branch, a new feature to get Reflection blob in WSL is enabled/added, which is to help get HLSL kernel singature/parameter list.
2. DirectXHeader: for communicating with user space driver
3. VCPKG: for installing dependencies
4. Gtest: for testing

For other orignal tvm dependencies，use this script to install https://gist.githubusercontent.com/wenxcs/dfad6bcb6293db241061d2b7fe7b11a9/raw/tvm_build.sh

Build Step:

Inside WSL

1. Build DirectX Shader Compiler:
   git clone git@github.com:nnfusion/DirectXShaderCompiler.git --branch wenxh/enable_reflection_blob_in_linux --recursive --single-branch dxc
   cmake -S dxc/ -B dxc/build/Release/ -GNinja -DCMAKE_BUILD_TYPE=Release -C dxc/cmake/caches/PredefinedParams.cmake
   cmake -- build dxc/build/Release/
   cp -frap dxc/include/dxc dxc/build/Release/include
2. Install VCPKG, Gtest, and DirectXHeaders:
   git clone https://github.com/microsoft/vcpkg
   ./vcpkg/bootstrap-vcpkg.sh
   ./vcpkg/vcpkg install gtest DirectX-Headers
3. Clone TVM
   git clone git@github.com:nnfusion/tvm.git --recursive
4. Cmake TVM
   cmake -S tvm/ -B tvm/build/Debug/ -DCMAKE_BUILD_TYPE=DEBUG -DDIRECTX_SHADER_COMPILER= -DUSE_DIRECTX=ON -DUSE_LLVM=ON -GNinja -DCMAKE_TOOLCHAIN_FILE=/home/wenxh/.opt/vcpkg/scripts/buildsystems/vcpkg.cmake
5. Build TVM
   cmake --build tvm/build/Debug/
6. Run test
   cd tvm/build/Debug/ && ./dx_test

On Windows

1. Download DirectXShaderCompiler artifact from original home page: https://github.com/microsoft/DirectXShaderCompiler#downloads
2. Install VCPKG and make it system intergrated for VS2022
3. Use VCPKG to Install DirectX-Headers:x64-windows gtest:x64-windows
4. Use VS2022 to open source folder (with submodules checkout)
   Remember to set DIRECTX_SHADER_COMPILER as dxc‘s home foder， and enable USE_DIRECTX=ON
5. You can find target named dx_test.exe in VS2022, build and run it to test
   If you wan to use CMake, try https://github.com/nnfusion/tvm/blob/develop/.github/workflows/directx_build.yml