Update documentation and source code for RMV v1.13

Author: ahosier

.clang-format

@@ -2,11 +2,11 @@ BasedOnStyle: Google
 IndentWidth: 4
 UseTab: Never
 ColumnLimit: 160
+
 Language: Cpp
 AccessModifierOffset: -4
 BreakBeforeBraces: Custom
 BraceWrapping:
-
   AfterCaseLabel: true
   AfterClass: true
   AfterControlStatement: true
@@ -23,7 +23,7 @@ BraceWrapping:
   SplitEmptyFunction: true
   SplitEmptyRecord: true
   SplitEmptyNamespace: true
-ConstructorInitializerAllOnOneLineOrOnePerLine : false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
 BreakConstructorInitializers: BeforeComma
 DerivePointerAlignment: false
 IndentCaseLabels: false
@@ -33,14 +33,16 @@ AlignConsecutiveDeclarations: true
 AlignEscapedNewlines: Left
 AlignTrailingComments: true
 AlignOperands: true
-AllowShortFunctionsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
 AllowShortIfStatementsOnASingleLine: false
 AllowShortLoopsOnASingleLine: false
-AllowShortBlocksOnASingleLine: false
+AllowShortBlocksOnASingleLine: Never
 ReflowComments: false
-SortIncludes: false
+SortIncludes: CaseSensitive
+IncludeBlocks: Preserve
 SortUsingDeclarations: false
 BinPackArguments: false
 BinPackParameters: false
 ExperimentalAutoDetectBinPacking: false
-AllowAllParametersOfDeclarationOnNextLine: false
+AllowAllParametersOfDeclarationOnNextLine: false
+

.gitignore

@@ -14,3 +14,5 @@ Buildinfo.properties
 external
 .vscode
 *.aps
+.vs/
+out/

CMakeLists.txt

@@ -7,12 +7,13 @@ cmake_minimum_required(VERSION 3.11)
 
 set(SYSTEM_INFO_BUILD_RDF_INTERFACES ON)
 
+
 ## Specify the top level name of the project - this will define the solution name for Visual Studio
 project(RMV)
 
 # Define version information
 set(RMV_MAJOR_VERSION 1)
-set(RMV_MINOR_VERSION 12)
+set(RMV_MINOR_VERSION 13)
 if (NOT RMV_BUGFIX_NUMBER)
     set(RMV_BUGFIX_NUMBER 0)
 endif ()
@@ -23,8 +24,8 @@ string(TIMESTAMP DATE "\"%m/%d/%Y\"")
 string(TIMESTAMP YEAR "%Y")
 string(TIMESTAMP YEAR_STRING "\"%Y\"")
 
-configure_file("${CMAKE_SOURCE_DIR}/Buildinfo.properties.in" "${CMAKE_SOURCE_DIR}/Buildinfo.properties")
-configure_file("${CMAKE_SOURCE_DIR}/source/frontend/util/version.h.in" "${CMAKE_SOURCE_DIR}/source/frontend/util/version.h")
+configure_file("${CMAKE_CURRENT_SOURCE_DIR}/Buildinfo.properties.in" "${CMAKE_CURRENT_SOURCE_DIR}/Buildinfo.properties")
+configure_file("${CMAKE_CURRENT_SOURCE_DIR}/source/frontend/util/version.h.in" "${CMAKE_CURRENT_SOURCE_DIR}/source/frontend/util/version.h")
 
 # Add cmake utilities
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
@@ -46,14 +47,14 @@ ENDIF()
 
 # As default for RMV, include the debug status in filename - but not the platform bitness
 set (CMAKE_DEBUG_POSTFIX -d)
-set (CMAKE_RELEASE_POSTFIX)
+set (CMAKE_RELEASE_POSTFIX )
 
 # Add for CentOS compiler warning
 add_definitions(-DJSON_SKIP_UNSUPPORTED_COMPILER_CHECK)
 
-include_directories("${PROJECT_SOURCE_DIR}/external/")
-include_directories("${PROJECT_SOURCE_DIR}/external/qt_common/")
-include_directories("${PROJECT_SOURCE_DIR}/external/third_party/")
+include_directories("${CMAKE_CURRENT_SOURCE_DIR}/external/")
+include_directories("${CMAKE_CURRENT_SOURCE_DIR}/external/qt_common/")
+include_directories("${CMAKE_CURRENT_SOURCE_DIR}/external/third_party/")
 
 # Global compiler options
 IF(WIN32)
@@ -94,10 +95,19 @@ MACRO(SOURCE_GROUP_BY_FOLDER target)
     ENDIF (files)
 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)
+if (NOT TARGET QtUtils)
+    add_subdirectory(external/qt_common qt_common)
+endif()
+
+if (NOT TARGET amdrdf)
+    add_subdirectory(external/rdf/imported/zstd)
+    add_subdirectory(external/rdf/rdf)
+endif()
+
+if (NOT TARGET system_info)
+    add_subdirectory(external/system_info_utils)
+endif()
+
 add_subdirectory(source/parser parser)
 add_subdirectory(source/backend backend)
 add_subdirectory(source/frontend frontend)
@@ -119,20 +129,22 @@ ENDIF(WIN32)
 ## Copy Documentation and Samples to output directory. Note - this target is intentionally not included in
 ## the default project build. It needs to be explicitly built as a separate project
 
-set(DOCS_OUTPUT_DIR ${CMAKE_BINARY_DIR})
+if(NOT APPLE)
+    set(DOCS_OUTPUT_DIR ${CMAKE_BINARY_DIR})
+endif()
 
 # group sphinx source files into a sphinx folder
-file(GLOB SPHINX_DOC_FILES ${SPHINX_DOC_FILES} ${CMAKE_SOURCE_DIR}/documentation/source/*.rst)
-set (SPHINX_DOC_MAIN ${CMAKE_SOURCE_DIR}/documentation/source/conf.py)
+file(GLOB SPHINX_DOC_FILES ${SPHINX_DOC_FILES} ${CMAKE_CURRENT_SOURCE_DIR}/documentation/source/*.rst)
+set (SPHINX_DOC_MAIN ${CMAKE_CURRENT_SOURCE_DIR}/documentation/source/conf.py)
 set (ALL_SPHINX_FILES ${SPHINX_DOC_FILES} ${SPHINX_DOC_MAIN})
 source_group("sphinx" FILES ${ALL_SPHINX_FILES})
 
 # group release documents into a release_docs folder
 set (RELEASE_DOCS_IN_ROOT
-     ${CMAKE_SOURCE_DIR}/README.md
-     ${CMAKE_SOURCE_DIR}/RELEASE_NOTES.txt
-     ${CMAKE_SOURCE_DIR}/NOTICES.txt
-     ${CMAKE_SOURCE_DIR}/LICENSE.txt
+     ${CMAKE_CURRENT_SOURCE_DIR}/README.md
+     ${CMAKE_CURRENT_SOURCE_DIR}/RELEASE_NOTES.txt
+     ${CMAKE_CURRENT_SOURCE_DIR}/NOTICES.txt
+     ${CMAKE_CURRENT_SOURCE_DIR}/LICENSE.txt
 )
 set (RELEASE_DOCS ${RELEASE_DOCS_IN_ROOT})
 source_group("release_docs" FILES ${RELEASE_DOCS})
@@ -148,25 +160,25 @@ if(SPHINX_EXECUTABLE)
     # this ensures the sphinx docs are built everytime you ask to build the Documentation target
     # Sphinx has proper dependency checking, so this works as expected.
     # Once built, clean up any unneeded files.
-    add_custom_target(Documentation ALL SOURCES ${ALL_SPHINX_FILES} ${RELEASE_DOCS} DEPENDS sphinx_output)
+    add_custom_target(RMVDocumentation ALL SOURCES ${ALL_SPHINX_FILES} ${RELEASE_DOCS} DEPENDS sphinx_output)
     add_custom_command(MAIN_DEPENDENCY ${SPHINX_DOC_MAIN} OUTPUT sphinx_output
         COMMAND ${CMAKE_COMMAND} -E echo "building Sphinx documentation"
-        COMMAND ${SPHINX_EXECUTABLE} ${CMAKE_SOURCE_DIR}/documentation/source ${DOCS_OUTPUT_DIR}/help/rmv/. -t ${SPHINX_OPTION}
+        COMMAND ${SPHINX_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/documentation/source ${DOCS_OUTPUT_DIR}/help/rmv/. -t ${SPHINX_OPTION}
         COMMAND ${CMAKE_COMMAND} -E remove_directory ${DOCS_OUTPUT_DIR}/help/rmv/.doctrees
     )
     install(DIRECTORY ${CMAKE_BINARY_DIR}/help DESTINATION . COMPONENT apps)
 else()
     message(WARNING "SPHINX_EXECUTABLE (sphinx-build) is not found! Documentation will not be built!")
     # If the sphinx binary isn't found, then just create the Documentation project with only the release docs in it.
-    add_custom_target(Documentation ALL SOURCES ${ALL_SPHINX_FILES} ${RELEASE_DOCS})
+    add_custom_target(RMVDocumentation ALL SOURCES ${ALL_SPHINX_FILES} ${RELEASE_DOCS})
 endif()
 
-add_custom_command(TARGET Documentation POST_BUILD
+add_custom_command(TARGET RMVDocumentation POST_BUILD
     COMMAND ${CMAKE_COMMAND} -E echo "copying Documentation to output directory"
     COMMAND ${CMAKE_COMMAND} -E copy_if_different ${RELEASE_DOCS_IN_ROOT}           ${DOCS_OUTPUT_DIR}/.
     COMMAND ${CMAKE_COMMAND} -E echo "copying Samples to output directory"
     COMMAND ${CMAKE_COMMAND} -E make_directory ${DOCS_OUTPUT_DIR}/samples
-    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/samples/sample_trace.rmv  ${DOCS_OUTPUT_DIR}/samples/sample_trace.rmv
+    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_CURRENT_SOURCE_DIR}/samples/sample_trace.rmv  ${DOCS_OUTPUT_DIR}/samples/sample_trace.rmv
 )
 
 install(FILES
@@ -184,6 +196,7 @@ if (WIN32)
     install(PROGRAMS ${CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS} DESTINATION . COMPONENT apps)
 endif (WIN32)
 
+
 # CPack packaging
 
 set(CPACK_ARCHIVE_COMPONENT_INSTALL ON)
@@ -192,6 +205,7 @@ set(CPACK_COMPONENTS_GROUPING IGNORE)
 set(CPACK_ARCHIVE_APPS_FILE_NAME "RadeonMemoryVisualizer_${RMV_MAJOR_VERSION}.${RMV_MINOR_VERSION}.${RMV_BUGFIX_NUMBER}.${RMV_BUILD_NUMBER}")
 set(CPACK_ARCHIVE_DEBUG_FILE_NAME "RadeonMemoryVisualizer-PDB_${RMV_MAJOR_VERSION}.${RMV_MINOR_VERSION}.${RMV_BUGFIX_NUMBER}.${RMV_BUILD_NUMBER}")
 
+
 include(CPack)
 
 cpack_add_component(apps

README.md

@@ -31,7 +31,7 @@ The Radeon Memory Visualizer (RMV) is a software tool that will allow users to a
 * AMD Radeon RX 7000 series
 * AMD Radeon RX 6000 series
 * AMD Radeon RX 5000 series
-* AMD Ryzen™ Processors with Radeon Graphics
+* AMD Ryzen™ Processors with AMD RDNA™ Architecture Graphics
 
 ## Supported Operating Systems
 * Windows® 10
@@ -42,9 +42,8 @@ The Radeon Memory Visualizer (RMV) is a software tool that will allow users to a
 Note: Before running RDP and capturing an RMV memory trace on Linux, be sure to make the necessary configuration changes by running the RDP setup.sh script each time the machine is rebooted. For more information, see the RDP documentation.
 
 ## Required hardware for SAM (Smart access memory) support
-* AMD Radeon RX 7000 series
-* AMD Radeon RX 6000 series
-* AMD Ryzen 5000 and higher series processors with Radeon Graphics
+* AMD Radeon RX 6000 series or higher
+* AMD Ryzen 5000 and higher series processors with AMD RDNA Architecture Graphics
 
 ## Build instructions
 See [BUILD.md](BUILD.md) for more details.

RELEASE_NOTES.txt

@@ -1,12 +1,11 @@
-Radeon™ Memory Visualizer V1.12 03/11/2025
+Radeon™ Memory Visualizer V1.13 06/17/2025
 ------------------------------------------
 
-V1.12 Changes
+V1.13 Changes
 ------------------------------------
-1) Support for AMD Radeon RX 9000 series GPUs
-2) New options to delete all snapshots or a selection of snapshots.
-3) Improved performance when loading snapshots for traces containing aliased resources.
-4) Bug/stability fixes.
+1) Optimize performance for the Allocation overview pane, helpful when allocations contain thousands of resources and/or aliasing is heavily used.
+2) Allow resource properties to be copied to the clipboard in the Resource details pane.
+3) Bug/stability fixes.
 
 Known Issues
 ------------------------------------
@@ -26,6 +25,13 @@ Known Issues
 Release Notes History
 ------------------------------------
 
+V1.12 Changes
+------------------------------------
+1) Support for AMD Radeon RX 9000 series GPUs.
+2) New options to delete all snapshots or a selection of snapshots.
+3) Improved performance when loading snapshots for traces containing aliased resources.
+4) Bug/stability fixes.
+
 V1.11 Changes
 ------------------------------------
 1) Dark mode user interface support, allowing the user to choose between a light and dark theme (or have RMV follow the OS theme setting).

build/dependency_map.py

@@ -21,7 +21,7 @@
 # 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
 git_mapping = {
-    github_tools + "qt_common"                 : ["../external/qt_common",         "v4.2.0", True],
+    github_tools + "qt_common"                 : ["../external/qt_common",         "v4.3.0", True],
     github_tools + "system_info_utils"         : ["../external/system_info_utils", "v2.1",   True],
     github_tools + "update_check_api"          : ["../external/update_check_api",  "v2.1.1", True],
     github_root  + "GPUOpen-Drivers/libamdrdf" : ["../external/rdf",               "v1.4.0", True],

build/fetch_dependencies.py

@@ -6,10 +6,7 @@
 ## \brief Script to fetch all external git and/or downloadable dependencies
 ##        needed to build the project.
 ##
-##   fetch_dependencies.py (--internal)
-##
-## If --internal is specified, then any additional dependencies required for internal builds will also
-## be checked out.
+##   fetch_dependencies.py
 ##
 ## Each git repo will be updated to the commit specified in the "gitMapping" table.
 ##=============================================================================

build/pre_build.py

@@ -69,7 +69,7 @@
 parser.add_argument("--no-qt", action="store_true", help="build a headless version (not applicable for all products)")
 parser.add_argument("--build-number", default="0", help="specify the build number, primarily to be used by build machines to produce versioned builds")
 parser.add_argument("--update", action="store_true", help="Force fetch_dependencies script to update all dependencies")
-parser.add_argument("--output", default=output_root, help="specify the output location for generated cmake and build output files (default = OS specific subdirectory of location of PreBuild.py script)")
+parser.add_argument("--output", default=output_root, help="specify the output location for generated cmake and build output files (default = OS specific subdirectory of location of pre_build.py script)")
 parser.add_argument("--build", action="store_true", help="build all supported configurations on completion of prebuild step")
 parser.add_argument("--build-jobs", default="16", help="number of simultaneous jobs to run during a build (default = 16)")
 parser.add_argument("--analyze", action="store_true", help="perform static analysis of code on build (currently VS2017 only)")
@@ -292,7 +292,6 @@ def generate_config(config):
     if sys.platform == "darwin":
         cmake_args.extend(["-DNO_APP_BUNDLE=" + str(args.no_bundle)])
 
-
     if args.vscode:
         # Generate data into VSCode Settings file
 
@@ -368,7 +367,7 @@ def generate_config(config):
 
             cmake_args = ["cmake", "--build", build_dir, "--parallel", args.build_jobs]
 
-            cmake_args_docs = ["cmake", "--build", build_dir, "--target", "Documentation", "--parallel", args.build_jobs]
+            cmake_args_docs = ["cmake", "--build", build_dir, "--target", "RMVDocumentation", "--parallel", args.build_jobs]
         elif sys.platform == "win32":
             build_dir = cmake_output_dir
 
@@ -378,7 +377,7 @@ def generate_config(config):
                 cmake_args.append("/p:CodeAnalysisRuleSet=NativeMinimumRules.ruleset")
                 cmake_args.append("/p:RunCodeAnalysis=true")
 
-            cmake_args_docs = ["cmake", "--build", build_dir, "--config", config, "--target", "Documentation", "--", "/m:" + args.build_jobs]
+            cmake_args_docs = ["cmake", "--build", build_dir, "--config", config, "--target", "RMVDocumentation", "--", "/m:" + args.build_jobs]
 
         p = subprocess.Popen(cmake_args, cwd=cmake_output_dir, stderr=subprocess.STDOUT)
         p.wait()
@@ -393,7 +392,6 @@ def generate_config(config):
         p.wait()
         sys.stdout.flush()
 
-
         if (args.package):
             if sys.platform == "win32":
                 cmake_args = ["cpack", "-G", "ZIP"]

documentation/requirements.txt

@@ -1,4 +1,4 @@
 # Defining requirements for docs
 sphinx==5.3.0
 sphinx_rtd_theme==1.1.1
-readthedocs-sphinx-search==0.1.1
+readthedocs-sphinx-search==0.3.2

documentation/source/compare_windows.rst

@@ -41,39 +41,3 @@ both snapshots, the base snapshot will be used.
 .. image:: media/compare/memory_leak_finder_1.png
 
 
-Vulkan resource naming
-----------------------
-Pipelines, images and buffers can be given unique names and these names will
-show up in the RMV UI. The Vulkan extension VK_EXT_debug_utils can be used for this.
-
-For more information, see the document:
-
-https://www.lunarg.com/wp-content/uploads/2018/05/Vulkan-Debug-Utils_05_18_v1.pdf
-
-specifically the section "Naming Objects"
-
-DirectX 12 resource naming
---------------------------
-Memory traces for DirectX applications captured with the Radeon Developer Panel
-can include unique names for resources like heaps, buffers and textures.  Names can be assigned to
-DirectX resources using the ``ID3D12Object::SetName()`` method.
-For more information, please review the Microsoft DirectX 12 documentation.
-
-Calling the ``SetName()``
-method results in ETW (Event Tracing for Windows) events being emitted and picked
-up by the Panel. This resource naming information is then included in the RMV trace
-file.
-
-Due to the asynchronous nature of the event tracing, memory events that happen a short time before the process exit
-may show up incorrectly in RMV in terms of naming, as well as
-marking and filtering out implicit heaps (created for committed resources)
-and implicit buffers (that D3D12 runtime creates automatically for every explicitly created heap).
-To overcome this problem, it is recommended to introduce a delay of few seconds
-between memory events of interest and the process exit.
-
-Viewing resource names
-----------------------
-The resource names will show up in the RMV UI in the resource list pane, for example:
-
-.. image:: media/vk_resource_naming_1.png
-