Merge pull request #67 from GPUOpen-Tools/development

Beta2 - origin/development

Author: kurbeco

.gitignore

@@ -34,6 +34,8 @@ ThirdParty/UnorderedDense/
 ThirdParty/BTree/
 ThirdParty/ZLIB/
 ThirdParty/AgilitySDK/
+ThirdParty/Eigen/
+ThirdParty/STB/
 
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.

.gitlab-ci.yml

@@ -8,19 +8,19 @@ stages:
 
 build_release:
   tags:
-  - windows
-  - amd64
+  - gpu-reshape
   stage: build
   script:
-  - 'cmake -G "Visual Studio 16 2019" -A x64 -DCMAKE_CONFIGURATION_TYPES:STRING="Release" -DINSTALL_THIRD_PARTY:BOOL="1" -B "cmake-build-vs2019" -DCMAKE_VS_NUGET_PACKAGE_RESTORE=ON'
-  - 'cmake -P Build/Utils/CSProjPatch.cmake cmake-build-vs2019'
+  - 'cmake -G "Visual Studio 17 2022" -A x64 -DCMAKE_CONFIGURATION_TYPES:STRING="RelWithDebInfo" -DINSTALL_THIRD_PARTY:BOOL="1" -B "cmake-build-vs2022" -DCMAKE_VS_NUGET_PACKAGE_RESTORE=ON'
+  - 'cmake -P Build/Utils/CSProjPatch.cmake cmake-build-vs2022'
+  - 'dotnet restore "cmake-build-vs2022/GPU-Reshape.sln"'
   # Workaround for https://gitlab.kitware.com/cmake/cmake/-/issues/18026
-  #  'cmake --build cmake-build-vs2019 --config Release --parallel 4 -- /p:CL_MPcount=16'
-  - '"cmake-build-vs2019/GRS_MSBuild.bat" "cmake-build-vs2019/GPU-Reshape.sln" /p:Configuration=Release'
+  #  'cmake --build cmake-build-vs2022 --config RelWithDebInfo --parallel 4 -- /p:CL_MPcount=16'
+  - '"cmake-build-vs2022/GRS_MSBuild.bat" "cmake-build-vs2022/GPU-Reshape.sln" /p:Configuration=RelWithDebInfo'
   artifacts:
     name: "GPU-Reshape-Release-$CI_COMMIT_SHORT_SHA"
     paths:
-    - Bin/MSVC/Release/
+    - Bin/MSVC/RelWithDebInfo/
 
 build_debug:
   tags:
@@ -29,11 +29,12 @@ build_debug:
   stage: build
   when: manual
   script:
-  - 'cmake -G "Visual Studio 16 2019" -A x64 -DCMAKE_CONFIGURATION_TYPES:STRING="Debug" -DINSTALL_THIRD_PARTY:BOOL="1" -B "cmake-build-vs2019" -DCMAKE_VS_NUGET_PACKAGE_RESTORE=ON'
-  - 'cmake -P Build/Utils/CSProjPatch.cmake cmake-build-vs2019'
+  - 'cmake -G "Visual Studio 17 2022" -A x64 -DCMAKE_CONFIGURATION_TYPES:STRING="Debug" -DINSTALL_THIRD_PARTY:BOOL="1" -B "cmake-build-vs2022" -DCMAKE_VS_NUGET_PACKAGE_RESTORE=ON'
+  - 'cmake -P Build/Utils/CSProjPatch.cmake cmake-build-vs2022'
+  - 'dotnet restore "cmake-build-vs2022/GPU-Reshape.sln"'
   # Workaround for https://gitlab.kitware.com/cmake/cmake/-/issues/18026
-  #  'cmake --build cmake-build-vs2019 --config Debug --parallel 4 -- /p:CL_MPcount=16'
-  - '"cmake-build-vs2019/GRS_MSBuild.bat" "cmake-build-vs2019/GPU-Reshape.sln" /p:Configuration=Debug'
+  #  'cmake --build cmake-build-vs2022 --config Debug --parallel 4 -- /p:CL_MPcount=16'
+  - '"cmake-build-vs2022/GRS_MSBuild.bat" "cmake-build-vs2022/GPU-Reshape.sln" /p:Configuration=Debug'
   artifacts:
     name: "GPU-Reshape-Debug-$CI_COMMIT_SHORT_SHA"
     paths:
@@ -47,11 +48,11 @@ package_release:
   dependencies:
   - build_release
   script:
-  - '"Build\Scripts\Package.bat" MSVC/Release'
+  - '"Build\Scripts\Package.bat" MSVC/RelWithDebInfo'
   artifacts:
     name: "GPU-Reshape-Release-$CI_COMMIT_SHORT_SHA"
     paths:
-    - Package/MSVC/Release/
+    - Package/MSVC/RelWithDebInfo/
 
 package_debug:
   tags:

Build/CSharp.cmake

@@ -34,47 +34,63 @@ function(Project_AddDotNet NAME)
     # DotNet
     set_target_properties(
         ${NAME} PROPERTIES
-        VS_DOTNET_TARGET_FRAMEWORK_VERSION "v4.8"
+		DOTNET_SDK "Microsoft.NET.Sdk"
+		DOTNET_TARGET_FRAMEWORK "net8.0"
+        VS_GLOBAL_Platforms "x64"
+		VS_GLOBAL_RuntimeIdentifier "win-x64"
+		VS_GLOBAL_AppendTargetFrameworkToOutputPath "false"
+		VS_GLOBAL_AppendRuntimeIdentifierToOutputPath "false"
         VS_GLOBAL_ROOTNAMESPACE ${NAME}
     )
 
     # IDE source discovery
     SetSourceDiscovery(${NAME} CS Include Source Schema)
 endfunction()
 
+# Add a .NET merge target for generated files
+#  ! Must be called in the same CMakeLists.txt as the custom commands
+function(Project_AddDotNetGeneratedMerge NAME GENERATED_SOURCES)
+	set(Command "")
+	
+	# Copy each schema target
+	foreach(File ${${GENERATED_SOURCES}})
+		list(APPEND Command COMMAND "${CMAKE_COMMAND}" -E copy "${File}.gen" "${File}")
+		
+		# Generated project / MSBUILD does not check that if inbound file originates from
+		# another target.
+		if (NOT EXISTS ${File})
+			file(WRITE "${File}" "Generation target file")
+		endif()
+	endforeach()
+	
+	# Schema Gen -> Schema
+	add_custom_target(
+		${NAME}
+		DEPENDS ${${GENERATED_SOURCES}_Gen}
+		BYPRODUCTS ${${GENERATED_SOURCES}}
+		${Command}
+	)
+endfunction()
+
 function(Project_AddDotNetEx)
     cmake_parse_arguments(
         ARGS
         "UNSAFE;EXECUTABLE" # Options
         "NAME;LANG;PROPS" # One Value
-        "SOURCE;GENERATED;ASSEMBLIES;LIBS;FLAGS" # Multi Value
+        "SOURCE;DEPENDENCIES;ASSEMBLIES;LIBS;FLAGS" # Multi Value
         ${ARGN}
     )
 
-    if (NOT "${ARGS_GENERATED}" STREQUAL "")
-        # Generate sham target
-        #   ! WORKAROUND, Visual Studio generators do not support C# sources from add_custom_command
-        #                 Check introduced by 3.24
-        add_library(${ARGS_NAME}.Sham INTERFACE ${${ARGS_GENERATED}_Sham})
-		
-		# Create dummy file to keep MSVC happy
-		if (NOT EXISTS "${CMAKE_CURRENT_BINARY_DIR}/${${ARGS_GENERATED}_Sham}")
-			file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/${${ARGS_GENERATED}_Sham}" Sham)
-		endif()
-    endif()
-
     # Create library
     if ("${ARGS_EXECUTABLE}")
         add_executable(
             ${ARGS_NAME}
             ${ARGS_SOURCE}
-            ${${ARGS_GENERATED}}
         )
     else()
         add_library(
             ${ARGS_NAME} SHARED
             ${ARGS_SOURCE}
-            ${${ARGS_GENERATED}}
         )
     endif()
 
@@ -95,7 +111,12 @@ function(Project_AddDotNetEx)
     # Set .NET, link to assemblies and libs
     set_target_properties(
         ${ARGS_NAME} PROPERTIES
-        VS_DOTNET_TARGET_FRAMEWORK_VERSION "v4.8"
+		DOTNET_SDK "Microsoft.NET.Sdk"
+		DOTNET_TARGET_FRAMEWORK "net8.0"
+        VS_GLOBAL_Platforms "x64"
+		VS_GLOBAL_RuntimeIdentifier "win-x64"
+		VS_GLOBAL_AppendTargetFrameworkToOutputPath "false"
+		VS_GLOBAL_AppendRuntimeIdentifierToOutputPath "false"
         VS_GLOBAL_ROOTNAMESPACE "${ARGS_NAME}"
         VS_DOTNET_REFERENCES "${ARGS_ASSEMBLIES};${ARGS_LIBS}"
         VS_USER_PROPS "${CMAKE_SOURCE_DIR}/Build/cs.configuration.props"
@@ -128,10 +149,10 @@ function(Project_AddDotNetEx)
         endif()
     endif()
 
-    # Reference sham target to let dependencies generate before use
-    if (NOT "${ARGS_GENERATED}" STREQUAL "")
-        add_dependencies(${ARGS_NAME} ${ARGS_NAME}.Sham)
-    endif()
+    # Add additional dependencies	
+	if (NOT "${ARGS_DEPENDENCIES}" STREQUAL "")
+        add_dependencies(${ARGS_NAME} ${ARGS_DEPENDENCIES})
+	endif()
 
     # IDE source discovery
     SetSourceDiscovery(${ARGS_NAME} ${ARGS_LANG} Include Source)

Build/Tools/package.py

@@ -27,6 +27,7 @@
 import os
 import sys
 import shutil
+import subprocess
 
 # Paths
 root_dir     = os.path.join("../", "../")
@@ -39,35 +40,48 @@
     # Mostly unit testing, build time tooling
     ".exe",
 
+    # All configuration json, handled through required files
+    ".json",
+    
     # Build time tooling dependencies
     "libclang.dll",
 
     # Test dependencies
-    "VK_GPUOpen_Test_UserDataLayer.json",
+    "GRS.Libraries.Message.Benchmark.DotNet.dll",
+    "GRS.Backends.Vulkan.Tests.UserDataLayer.dll",
     "vulkan-1.dll"
 ]
 
+publish_projects = [
+    # "Source/UIX/Studio/Studio.csproj",
+    # "Source/Services/Discovery/DotNet/NotifyIcon/NotifyIcon.csproj"
+]
+
 # All required files
 require_list = [
     # <The> GPU Reshape
     "GPUReshape.exe",
 
-    # Dependencies
-    "GPUReshape.NotifyIcon.exe",
-    "GRS.Backends.DX12.Service.exe",
-    "GRS.Backends.DX12.Service.RelFunTBL.exe",
-    "GRS.Services.HostResolver.Standalone.exe",
-    "GRS.Services.Discovery.Cleanup.exe",
-    "XamlColorSchemeGenerator.exe",
+    # Executable dependencies
+    "GPUReshape.NotifyIcon.exe",                 # Task bar notification icon
+    "GRS.Backends.DX12.Service.exe",             # Handles project detouring for D3D12 objects
+    "GRS.Backends.DX12.Service.RelFunTBL.exe",   # Relative function table generator for x86
+    "GRS.Services.HostResolver.Standalone.exe",  # Host resolver tool for discovery
+    "GRS.Services.Discovery.Cleanup.exe",        # General cleanup tool for discovery
+    "XamlColorSchemeGenerator.exe",              # UIX dependency
+    
+    # UIX runtime dependency json
+    "GPUReshape.deps.json",
+    "GPUReshape.runtimeconfig.json",
+    "GPUReshape.NotifyIcon.deps.json",
+    "GPUReshape.NotifyIcon.runtimeconfig.json",
+    "VK_LAYER_GPUOPEN_GRS.json"
 ]
 
 # All required folders
 require_folders = [
     "Plugins",
-    "runtimes/win",
-    "runtimes/win-x64",
-    "runtimes/win-arm64",
-    "runtimes/win7-x64"
+    "Dependencies"
 ]
 
 # All extra folders
@@ -155,3 +169,15 @@
         # Copy all contents
         sys.stdout.write(f"\tPackaging {folder[0]}\n")
         shutil.copytree(src_folder_dir, pck_folder_dir)
+        
+    # Package all relevant projects
+    for project in publish_projects:
+        subprocess.run([
+            "dotnet",
+            "publish",
+            os.path.join(root_dir, project),
+            "-c", package.split('/')[-1],
+            "-o", pck_dir,
+            "--self-contained",
+            "-r", "win-x64"
+        ])

Build/cs.configuration.props

@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+    <PropertyGroup>
+        <ResolveNuGetPackages>false</ResolveNuGetPackages>
+    </PropertyGroup>
     <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='RelWithDebInfo|x64'" Label="Configuration">
         <Optimize>true</Optimize>
     </PropertyGroup>

CMakeLists.txt

@@ -149,8 +149,8 @@ if (${ENABLE_UIX} AND CMAKE_GENERATOR MATCHES "Visual Studio")
     enable_language(CSharp)
 
     # Set standard C# properties
-    SET(CMAKE_DOTNET_TARGET_FRAMEWORK_VERSION "v4.8")
-    SET(CMAKE_CSharp_FLAGS "/langversion:6")
+    SET(CMAKE_DOTNET_TARGET_FRAMEWORK "net8.0")
+    SET(CMAKE_CSharp_FLAGS "/langversion:latest")
     SET(CMAKE_CSharp_FLAGS "/platform:x64")
 else()
     set(BUILD_UIX OFF)
@@ -204,11 +204,15 @@ endforeach()
 
 # Configure file for multi-configurators
 function(ConfigureOutput FILE OUT)
+    get_filename_component(Directory "${OUT}" DIRECTORY)
+
     if ("${CMAKE_BUILD_TYPE}" STREQUAL "")
         foreach(Config ${CMAKE_CONFIGURATION_TYPES})
+            file(MAKE_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${Config}/${Directory})
             configure_file(${FILE} ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${Config}/${OUT} COPYONLY)
         endforeach()
     else()
+        file(MAKE_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${Directory})
         configure_file(${FILE} ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${OUT} COPYONLY)
     endif()
 endfunction()
@@ -224,6 +228,8 @@ endfunction()
 # Add build support
 if (NOT THIN_X86_BUILD)
     add_subdirectory(Build)
+else()
+    include(Build/Files.cmake)
 endif()
 
 # Add external projects

Documentation/Build.md

@@ -1,17 +1,16 @@
 # Build Instructions
 
-Build instructions for Windows. _Linux support pending._
+Build instructions for Windows. _Linux support upcoming!_
 
 ## Supported environments
 
-A minimum version of **CMake 3.17** is required to configure and build the project. Additionally, pulled dependencies expect the following tools to be installed on the system:
+A minimum version of **CMake 3.24** is required to configure and build the project. Additionally, pulled dependencies expect the following tools to be installed on the system:
 
 - **Python 3.x**
 
-Building experimental UIX requires the following dependencies to be installed on the system:
+Building UIX requires the following dependencies to be installed on the system:
 
-- **.NET Framework 4.8 (.NET 5.0)**
-- **.NET Core SDK**
+- **.NET 8.0 SDK**
 
 ### Windows
 
@@ -21,23 +20,28 @@ Standard Visual Studio solutions may be generated by invoking the VisualStudio[V
 the below set-ups are supported:
 
 - Toolchains
-    - Visual Studio 2017 / 2019 / 2022
+    - Visual Studio 2022 17.8 (or just the build tools)
 - Generators
     - Visual Studio
     - Ninja
 - Compilers
     - MSVC
     - Clang-cl (11+)
 
+CMake / solution-generation is friendly for Visual Studio, Rider, and CLion!
+
 ## Configuration options
 
-| Option                | Platform | Default | Description                                                      |
-|-----------------------|----------|---------|------------------------------------------------------------------|
-| INSTALL_THIRD_PARTY   | All      | `ON`    | Fetch and install third party libraries                          |
-| ENABLE_UIX            | All      | `ON`    | Enables UIX building                                             |
-| ENABLE_BACKEND_VULKAN | All      | `ON`    | Enables Vulkan support                                           |
-| ENABLE_BACKEND_DX12   | All      | `ON`    | Enables DX12 support                                             |
-| ENABLE_MIXED_COMPILER | All      | `ON`    | Enables support for multiple compilers, separates built binaries |
+| Option                  | Platform | Default | Description                                                      |
+|-------------------------|----------|---------|------------------------------------------------------------------|
+| INSTALL_THIRD_PARTY     | All      | `ON`    | Fetch and install third party libraries                          |
+| ENABLE_UIX              | All      | `ON`    | Enables UIX building                                             |
+| ENABLE_BACKEND_VULKAN   | All      | `ON`    | Enables Vulkan support                                           |
+| ENABLE_BACKEND_DX12     | All      | `ON`    | Enables DX12 support                                             |
+| ENABLE_MIXED_COMPILER   | All      | `ON`    | Enables support for multiple compilers, separates built binaries |
+| ENABLE_NUGET_RESTORE    | All      | `ON`    | Enables nuget package restores on configuration                  |
+| ENABLE_X86_BOOTSTRAPPER | All      | `ON`    | Enables the 32-bit bootstrapper for detoured applications        |
+| ENABLE_EXPERIMENTAL     | All      | `ON`    | Enable experimental features                                     |
 
 Please see *Developmental configuration options* below for additional options.
 

Documentation/Redist/ReadMe.md

@@ -1,5 +1,11 @@
 
 # Redist
 
-This toolset requires the .NET SDK 5.0 runtimes which may be found below: </br>
-https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/sdk-5.0.408-windows-x64-installer
+### .NET Desktop Runtime 8.0.7 </br>
+https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-8.0.7-windows-x64-installer
+
+### Visual C++ Runtimes 17 </br>
+https://aka.ms/vs/17/release/vc_redist.x64.exe
+https://aka.ms/vs/17/release/vc_redist.x86.exe
+
+Both x64 and x86 are required. This is due to process bootstrapping operating across both 64 and 32 bit processes.