Update source code for RRA v1.5 release

Author: ahosier

.gitignore

@@ -11,6 +11,6 @@ documentation/build
 documentation/source/_build
 source/frontend/version.h
 Buildinfo.properties
-external
 .vscode
 *.aps
+

CMakeLists.txt

@@ -1,5 +1,13 @@
+#######################################################################################################################
+### Copyright (c) 2020-2024 Advanced Micro Devices, Inc. All rights reserved.
+### @author AMD Developer Tools Team
+#######################################################################################################################
+
 cmake_minimum_required(VERSION 3.11)
 
+set(SYSTEM_INFO_BUILD_RDF_INTERFACES ON)
+
+
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake")
 include(dev_tools)
 
@@ -8,7 +16,7 @@ project(RRA)
 
 # Define version information
 set(RRA_MAJOR_VERSION 1)
-set(RRA_MINOR_VERSION 4)
+set(RRA_MINOR_VERSION 5)
 if (NOT RRA_BUGFIX_NUMBER)
     set(RRA_BUGFIX_NUMBER 0)
 endif ()
@@ -52,6 +60,7 @@ ELSE(WIN32)
     set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG ${CMAKE_BINARY_DIR}/../../debug)
 ENDIF(WIN32)
 
+
 # Add for CentOS compiler warning
 add_definitions(-DJSON_SKIP_UNSUPPORTED_COMPILER_CHECK)
 
@@ -102,6 +111,7 @@ ENDMACRO(SOURCE_GROUP_BY_FOLDER)
 add_subdirectory(external/qt_common qt_common)
 add_subdirectory(external/rdf/imported/zstd)
 add_subdirectory(external/rdf/rdf)
+add_subdirectory(external/system_info_utils)
 add_subdirectory(source/backend backend)
 add_subdirectory(source/frontend frontend)
 add_subdirectory(source/renderer renderer)
@@ -188,3 +198,4 @@ add_custom_command(TARGET Documentation POST_BUILD
     COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/samples/landscape.rra  ${DOCS_OUTPUT_DIR}/samples/sample_trace.rra
 )
 
+

build/dependency_map.py

@@ -1,6 +1,6 @@
 #! python3
 ##=============================================================================
-## Copyright (c) 2021-2023 Advanced Micro Devices, Inc. All rights reserved.
+## Copyright (c) 2021-2024 Advanced Micro Devices, Inc. All rights reserved.
 ## \author AMD Developer Tools Team
 ## \file
 ## \brief List of all external dependencies.
@@ -20,13 +20,15 @@
 
 # Define a set of dependencies that exist as separate git projects.
 # each git dependency has a desired directory where it will be cloned - along with a commit to checkout
+# The third parameter in the value field is whether to do a shallow clone. Usually, this will be True but if a commit hash is used as a branch, a full clone is needed.
 git_mapping = {
-    github_tools + "QtCommon"                                       : ["../external/qt_common",          "v3.12.0"],
-    github_tools + "UpdateCheckAPI"                                 : ["../external/update_check_api",   "v2.0.1"],
-    github_root  + "g-truc/glm"                                     : ["../external/third_party/glm",    "0.9.9.8"],
-    github_root  + "KhronosGroup/Vulkan-Headers"                    : ["../external/third_party/vulkan", "sdk-1.3.211"],
-    github_root  + "zeux/volk"                                      : ["../external/third_party/volk",   "1.2.190"],
-    github_root  + "GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator" : ["../external/vma",                "d2f0313d20c803f83cc3637ac1facf8e4d6899e4"],
-    github_root  + "GPUOpen-Drivers/libamdrdf"                      : ["../external/rdf",                "v1.1.2"],
+    github_tools + "QtCommon"                                       : ["../external/qt_common",          "v3.12.0",                                  True],
+    github_tools + "UpdateCheckApi"                                 : ["../external/update_check_api",   "v2.1.0",                                   True],
+    github_tools + "system_info_utils"                              : ["../external/system_info_utils",  "88a338a01949f8d8bad60a30b78b65300fd13a9f", False],
+    github_root  + "g-truc/glm"                                     : ["../external/third_party/glm",    "0.9.9.8",                                  True],
+    github_root  + "KhronosGroup/Vulkan-Headers"                    : ["../external/third_party/vulkan", "sdk-1.3.211",                              True],
+    github_root  + "zeux/volk"                                      : ["../external/third_party/volk",   "1.2.190",                                  True],
+    github_root  + "GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator" : ["../external/vma",                "d2f0313d20c803f83cc3637ac1facf8e4d6899e4", False],
+    github_root  + "GPUOpen-Drivers/libamdrdf"                      : ["../external/rdf",                "v1.1.2",                                   True],
 }
 

build/fetch_dependencies.py

@@ -1,6 +1,6 @@
 #! python3
 ##=============================================================================
-## Copyright (c) 2020-2023 Advanced Micro Devices, Inc. All rights reserved.
+## Copyright (c) 2020-2024 Advanced Micro Devices, Inc. All rights reserved.
 ## \author AMD Developer Tools Team
 ## \file
 ## \brief Script to fetch all external git and/or downloadable dependencies
@@ -22,6 +22,11 @@
 import platform
 import argparse
 
+# Indices for fields in the git_mapping struct.
+kDestinationIndex = 0
+kCommitIndex = 1
+kShallowCloneIndex = 2
+
 # Check for the python 3.x name and import it as the 2.x name
 try:
     import urllib.request as urllib
@@ -48,19 +53,23 @@ def log_print(message):
 def update_git_dependencies(git_mapping, update):
     for git_repo in git_mapping:
         # add script directory to path
-        tmp_path = os.path.join(script_root, git_mapping[git_repo][0])
+        tmp_path = os.path.join(script_root, git_mapping[git_repo][kDestinationIndex])
 
         # clean up path, collapsing any ../ and converting / to \ for Windows
         path = os.path.normpath(tmp_path)
 
         # required commit
-        reqd_commit = git_mapping[git_repo][1]
+        reqd_commit = git_mapping[git_repo][kCommitIndex]
+        shallow_clone = git_mapping[git_repo][kShallowCloneIndex]
 
         do_checkout = False
         if not os.path.isdir(path):
             # directory doesn't exist - clone from git
             log_print("Directory %s does not exist, using 'git clone' to get latest from %s" % (path, git_repo))
-            p = subprocess.Popen((["git", "clone", git_repo ,path]), stderr=subprocess.STDOUT)
+            if (shallow_clone):
+                p = subprocess.Popen((["git", "clone", "--depth", "1", "--branch", reqd_commit, git_repo ,path]), stderr=subprocess.STDOUT)
+            else:
+                p = subprocess.Popen((["git", "clone", git_repo ,path]), stderr=subprocess.STDOUT)
             p.wait()
             if(p.returncode == 0):
                 do_checkout = True

build/pre_build.py

@@ -1,6 +1,6 @@
 #! python3
 ##=============================================================================
-## Copyright (c) 2020-2023 Advanced Micro Devices, Inc. All rights reserved.
+## Copyright (c) 2020-2024 Advanced Micro Devices, Inc. All rights reserved.
 ## \author AMD Developer Tools Team
 ## \file
 ## \brief Script to perform all necessary pre build steps. This includes:
@@ -36,7 +36,6 @@
 else:
     can_fetch = False
 
-
 # to allow the script to be run from anywhere - not just the cwd - store the absolute path to the script file
 script_root = os.path.dirname(os.path.realpath(__file__))
 
@@ -170,7 +169,6 @@ def check_qt_path(qt_root, qt_root_arg, qt_arg):
     if args.platform == "x86":
         cmake_output_dir += args.platform
 
-
 # Clean all files generated by this script or the build process
 if (args.clean):
     log_print ("Cleaning build ...\n")
@@ -204,7 +202,6 @@ def check_qt_path(qt_root, qt_root_arg, qt_arg):
     qt_expanded_root = os.path.expanduser(args.qt_root)
     qt_found,qt_path = check_qt_path(qt_expanded_root, args.qt_root, args.qt)
 
-
     if qt_found == False:
         log_error_and_exit(qt_path)
 
@@ -261,7 +258,6 @@ def generate_config(config):
             elif args.toolchain == "2017":
                 cmake_args.extend(["-Tv141"])
 
-
     if sys.platform.startswith('linux'):
         if args.qt_system:
             cmake_args.extend(["-DQT_SYSTEM:BOOL=TRUE"])
@@ -361,8 +357,6 @@ def generate_config(config):
             # For Visual Studio, specify the config to build
             cmake_args = ["cmake", "--build", build_dir, "--config", config, "--target", "ALL_BUILD", "--",  "/m:" + args.build_jobs]
             if args.analyze:
-#                cmake_args.append("/p:CodeAnalysisTreatWarningsAsErrors=true")
-#                cmake_args.append("/p:CodeAnalysisRuleSet=NativeRecommendedRules.ruleset")
                 cmake_args.append("/p:CodeAnalysisRuleSet=NativeMinimumRules.ruleset")
                 cmake_args.append("/p:RunCodeAnalysis=true")
 

cmake/FindXCB.cmake

@@ -48,4 +48,4 @@ foreach(comp ${XCB_FIND_COMPONENTS})
     endif()
 endforeach()
 
-list(REMOVE_DUPLICATES XCB_INCLUDE_DIRS)
+list(REMOVE_DUPLICATES XCB_INCLUDE_DIRS)

cmake/dev_tools.cmake

@@ -1,5 +1,5 @@
 #######################################################################################################################
-### Copyright (c) 2019-2023 Advanced Micro Devices, Inc. All rights reserved.
+### Copyright (c) 2019-2024 Advanced Micro Devices, Inc. All rights reserved.
 ### \author AMD Developer Tools Team
 #######################################################################################################################
 
@@ -76,3 +76,4 @@ function(devtools_target_options name)
     endif ()
 
 endfunction()
+

cmake/devtools_qt_helper.cmake

@@ -1,10 +1,11 @@
 #######################################################################################################################
-### Copyright (c) 2019-2021 Advanced Micro Devices, Inc. All rights reserved.
+### Copyright (c) 2019-2024 Advanced Micro Devices, Inc. All rights reserved.
 ### @author AMD Developer Tools Team
 #######################################################################################################################
 
 cmake_minimum_required(VERSION 3.10)
 
+
 # Attempt to automatically find Qt on the local machine
 if (UNIX AND NOT APPLE)
     find_package(Qt6 QUIET COMPONENTS Core Widgets Network Gui Svg Test GuiPrivate CorePrivate)
@@ -150,3 +151,4 @@ if (Qt5_DIR OR Qt6_DIR)
         endif ()
     endfunction()
 endif ()
+

shaders/GeometryColorTreeLevel.vs.spv

@@ -1,16 +1,23 @@
+#######################################################################################################################
+### Copyright (c) 2020-2024 Advanced Micro Devices, Inc. All rights reserved.
+### @author AMD Developer Tools Team
+#######################################################################################################################
+
 cmake_minimum_required(VERSION 3.11)
 
 project(Backend)
 
 set(CMAKE_INCLUDE_CURRENT_DIR ON)
-include_directories(AFTER ../backend)
+include_directories(AFTER ../backend ../../external/rdf/rdf/inc)
 
 # List of all source files. It may be possible to have the build process call cmake to update the makefiles
 # only when this file has changed (ie source files have been added or removed)
+
 set( SOURCES
     # common interface include files
     "public/rra_api_info.h"
     "public/rra_asic_info.h"
+    "public/rra_system_info.h"
     "public/rra_assert.h"
     "public/rra_blas.h"
     "public/rra_bvh.h"
@@ -41,10 +48,10 @@ set( SOURCES
     "rra_data_set.h"
     "rra_print.cpp"
     "rra_ray_history.cpp"
+    "rra_system_info.cpp"
     "rra_tlas.cpp"
     "rra_tlas_impl.h"
     "rra_trace_loader.cpp"
-    "rra_ray_history.cpp"
     "surface_area_heuristic.cpp"
     "surface_area_heuristic.h"
     "rra_async_ray_history_loader.cpp"
@@ -111,6 +118,7 @@ set( LINUX_SOURCES
     "linux/safe_crt.cpp"
 )
 
+
 # specify output library name
 IF(WIN32)
     add_library(${PROJECT_NAME} ${SOURCES})
@@ -122,6 +130,8 @@ ENDIF(WIN32)
 devtools_target_options(${PROJECT_NAME})
 
 target_compile_definitions(${PROJECT_NAME} PRIVATE -DRDF_CXX_BINDINGS)
+target_compile_definitions(${PROJECT_NAME} PRIVATE -DSYSTEM_INFO_ENABLE_RDF)
+
 IF (WIN32)
     target_compile_definitions(${PROJECT_NAME} PRIVATE -DRDF_PLATFORM_WINDOWS -D_CRT_SECURE_NO_WARNINGS)
 ELSEIF(UNIX)
@@ -140,3 +150,4 @@ foreach(source IN LISTS SOURCES)
 endforeach()
 ENDIF(WIN32)
 
+

source/backend/CMakeLists.txt

@@ -1,5 +1,5 @@
 //=============================================================================
-// Copyright (c) 2022-2023 Advanced Micro Devices, Inc. All rights reserved.
+// Copyright (c) 2022-2024 Advanced Micro Devices, Inc. All rights reserved.
 /// @author AMD Developer Tools Team
 /// @file
 /// @brief  Implementation for the API Info class.
@@ -40,7 +40,6 @@ namespace rra
         }
 
         std::uint32_t chunk_version = chunk_file.GetChunkVersion(identifier);
-        RRA_UNUSED(chunk_version);
 
         uint64_t header_size  = chunk_file.GetChunkHeaderSize(identifier);
         uint64_t payload_size = chunk_file.GetChunkDataSize(identifier);
@@ -52,13 +51,37 @@ namespace rra
             chunk_file.ReadChunkHeaderToBuffer(identifier, header.data());
         }
 
-        if (payload_size > 0)
+        if (payload_size > 0 && payload_size <= sizeof(TraceChunkApiInfo))
         {
             chunk_file.ReadChunkDataToBuffer(identifier, &chunk_data_);
-        }
 
-        chunk_data_valid_ = true;
-        return kRraOk;
+            if (chunk_version == 1)
+            {
+                std::unordered_map<TraceApiType_v1, TraceApiType> api_map = {{TraceApiType_v1::DIRECTX_9, TraceApiType::DIRECTX_9},
+                                                                             {TraceApiType_v1::DIRECTX_11, TraceApiType::DIRECTX_11},
+                                                                             {TraceApiType_v1::DIRECTX_12, TraceApiType::DIRECTX_12},
+                                                                             {TraceApiType_v1::VULKAN, TraceApiType::VULKAN},
+                                                                             {TraceApiType_v1::OPENGL, TraceApiType::OPENGL},
+                                                                             {TraceApiType_v1::OPENCL, TraceApiType::OPENCL},
+                                                                             {TraceApiType_v1::MANTLE, TraceApiType::MANTLE},
+                                                                             {TraceApiType_v1::GENERIC, TraceApiType::GENERIC}};
+
+                // Map old API enum values to new ones.
+                const auto& it = api_map.find(static_cast<TraceApiType_v1>(chunk_data_.api_type));
+                if (it != api_map.end())
+                {
+                    chunk_data_.api_type = (*it).second;
+                }
+            }
+
+            chunk_data_valid_ = true;
+            return kRraOk;
+        }
+        else
+        {
+            return kRraMajorVersionIncompatible;
+        }
+        return kRraErrorMalformedData;
     }
 
     const char* ApiInfo::GetApiName() const
@@ -70,6 +93,8 @@ namespace rra
 
         switch (chunk_data_.api_type)
         {
+        case TraceApiType::GENERIC:
+            return "Generic";
         case TraceApiType::DIRECTX_9:
             return "DirectX 9";
         case TraceApiType::DIRECTX_11:
@@ -84,8 +109,10 @@ namespace rra
             return "OpenCL";
         case TraceApiType::MANTLE:
             return "Mantle";
-        case TraceApiType::GENERIC:
-            return "Generic";
+        case TraceApiType::HIP:
+            return "HIP";
+        case TraceApiType::METAL:
+            return "METAL";
 
         default:
             return "";

source/backend/api_info.cpp

@@ -1,5 +1,5 @@
 //=============================================================================
-// Copyright (c) 2022-2023 Advanced Micro Devices, Inc. All rights reserved.
+// Copyright (c) 2022-2024 Advanced Micro Devices, Inc. All rights reserved.
 /// @author AMD Developer Tools Team
 /// @file
 /// @brief  Definition for the API Info class.
@@ -42,7 +42,7 @@ namespace rra
         bool IsVulkan() const;
 
         /// @brief enum of API types.
-        enum class TraceApiType : uint32_t
+        enum class TraceApiType_v1 : uint32_t
         {
             DIRECTX_9  = 0,
             DIRECTX_11 = 1,
@@ -54,6 +54,20 @@ namespace rra
             GENERIC    = 7
         };
 
+        enum class TraceApiType : uint32_t
+        {
+            GENERIC    = 0,
+            DIRECTX_9  = 1,
+            DIRECTX_11 = 2,
+            DIRECTX_12 = 3,
+            VULKAN     = 4,
+            OPENGL     = 5,
+            OPENCL     = 6,
+            MANTLE     = 7,
+            HIP        = 8,
+            METAL      = 9
+        };
+
         /// @brief The API Info chunk data format.
         struct TraceChunkApiInfo
         {