GPA 4.4 updates

Author: PLohrmannAMD

BUILD.md

@@ -21,6 +21,7 @@
       * `pip install pyenchant`
       * `pip install sphinxcontrib-spelling`
     * **Note:** Be sure to add Python scripts to PATH in order to build documentation from pre_build scripts.
+  * C++20 compiler toolchain that supports `std::format` (GNU 13+, Clang 17+, etc.)
 
 ## Windows Build Information
 The Windows projects each include a .rc file that embeds the VERSIONINFO resource into the final binary.
@@ -54,7 +55,7 @@ python build/pre_build.py --help
 
 Additional switches that can be used with the pre_build.py script:
 --vs=[2022]: Specify the Visual Studio version for which to generate projects. Default is 2022.
---config=[debug,release]: Specify the config for which to generate makefiles. Default is both. A specific config can only be specified on Linux. On Windows, both configs are always supported by the generated VS solution and project files.
+--config=[Debug,Release]: Specify the config for which to generate makefiles. Default is both. A specific config can only be specified on Linux. On Windows, both configs are always supported by the generated VS solution and project files.
 --clean: Delete cmake-generated directories created by this script
 --skipdx11: Does not generate build files for DX11 version of GPA (Windows only)
 --skipdx12: Does not generate build files for DX12 version of GPA (Windows only)
@@ -99,7 +100,7 @@ cmake --build build/win/ --config Debug
 
 On Linux
 
-Assuming you use `Unix Makefiles` which is the default `generator` on Windows
+Assuming you use `Unix Makefiles` which is the default `generator` on Linux
 
 ```sh
 cmake -S . -B build/linux -D CMAKE_BUILD_TYPE=Debug
@@ -115,26 +116,21 @@ NOTES:
 
 NOTE: The PublicCounterCompiler Tool requires using the `Visual Studio` generator due to `C#` usage!
 
-The PublicCounterCompiler Tool is a C# utility that will generate C++ code to define the public (or derived) counters.
-It takes as input text files contained in the [public_counter_compiler_input_files](source/public_counter_compiler_input_files) directory and
-outputs files in the [gpu_perf_api_counter_generator](source/auto_generated/gpu_perf_api_counter_generator), [gpu_perf_api_unit_tests](source/auto_generated/gpu_perf_api_unit_tests)
-and [docs](docs) directories.
-
-There are three ways to execute the tool:
-* With no parameters - the user interface opens with no fields prepopulated.
-* With two parameters - the user interface opens with the two main fields prepopulated. Note that pressing the "Compile Public Counters" button will load the correct input files and generate the output files in the correct location.
-  * Param 1: **API** - the API to compile counters for (e.g. GL, CL, DX11, DX12, VK, etc.)
-  * Param 2: **HW generation** - the generation to compile counters for (ex: Gfx9, Gfx10, Gfx11 etc.)
-* With six or seven parameters - the user interface does not open and will generate the C++ files using the specified input and output file locations.
-  * Param 1: **Counter names file** - text file containing hardware counter names and type (CounterNames[API][GEN].txt)
-  * Param 2: **Public counter definition file** - text file defining how the public counters are calculated (PublicCounterDefinitions\*.txt)
-  * Param 3: **Output Dir** - the directory to generate the output in (e.g. the path to the GPUPerfAPICounterGenerator directory)
-  * Param 4: **Test output Dir** - the directory to generate the test output in (e.g. the path to the GPUPerfAPIUnitTests/counters directory)
-  * Param 5: **API** - the API to take the counter names from (e.g. DX12)
-  * Param 6: **GPU** - the GPU to take the counter names from (e.g. Gfx11)
-  * Param 7: **GPU ASIC** - the subversion of GPU to take the counter names from (optional)
-
-See the various `public_counter_definitions_*.txt` files in the [public_counter_compiler_input_files](source/public_counter_compiler_input_files) directory. These contain all the counter definitions.
+The PublicCounterCompiler Tool is a C# CLI utility that generates C++ code to define the public (or derived) counters.
+It reads counter definition files from [source/codegen](source/codegen) and outputs files to
+[source/auto_generated/gpu_perf_api_counter_generator](source/auto_generated/gpu_perf_api_counter_generator),
+[source/auto_generated/gpu_perf_api_unit_tests/counters](source/auto_generated/gpu_perf_api_unit_tests/counters),
+and [documentation/sphinx/source](documentation/sphinx/source).
+
+```sh
+# Generate the C++ code
+PublicCounterCompiler
+
+# Get command line options for more granular control
+PublicCounterCompiler --help
+```
+
+See the `public_counter_definitions_*.txt` files in [source/codegen](source/codegen). These contain all the counter definitions.
 Each counter is given a name, a description, a type, an optional usage type, a list of hardware counters required and a formula applied to the values of the hardware counters to calculate the value of the counter.
 
 Counter formulas are expressed in a Reverse Polish Notation and are made up the following elements:

CMakeLists.txt

@@ -1,10 +1,10 @@
-## Copyright (C) 2018-2026 Advanced Micro Devices, Inc. All rights reserved. ##
+#/ Copyright (C) Advanced Micro Devices, Inc. All rights reserved.
 
 cmake_minimum_required(VERSION 3.25)
 set(GPA_CMAKE_MODULES_DIR ${CMAKE_CURRENT_SOURCE_DIR}/build/cmake_modules)
 
 set(GPA_MAJOR_VERSION 4)
-set(GPA_MINOR_VERSION 3)
+set(GPA_MINOR_VERSION 4)
 set(GPA_UPDATE_VERSION 0)
 
 if(NOT DEFINED build)
@@ -26,31 +26,38 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
 set(CMAKE_MSVC_DEBUG_INFORMATION_FORMAT "Embedded")
-
-if(NOT ${skiptests} AND NOT TARGET gtest)
-    enable_testing()
-    block()
-        set(CMAKE_FOLDER "Tests")
-        set(BUILD_GMOCK OFF)
-        set(INSTALL_GTEST OFF)
-        add_subdirectory(external/googletest EXCLUDE_FROM_ALL SYSTEM)
-    endblock()
-endif()
-
-add_subdirectory(external/device_info)
-add_subdirectory(external/tsingleton)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+set(CMAKE_C_VISIBILITY_PRESET "hidden")
+set(CMAKE_CXX_VISIBILITY_PRESET "hidden")
+set(CMAKE_VISIBILITY_INLINES_HIDDEN "YES")
 
 if(NOT ${skipdocs})
     add_subdirectory(documentation/sphinx)
 endif()
 
-if (NOT skipvulkan)
-    block()
-        add_subdirectory(external/Vulkan-Headers EXCLUDE_FROM_ALL SYSTEM)
-        add_subdirectory(source/third_party/AmdVkExt SYSTEM)
-    endblock()
+if(NOT ${skiptests})
+    enable_testing()
 endif()
 
+block()
+    set(CMAKE_FOLDER "${CMAKE_FOLDER}/external")
+
+    add_subdirectory(external/device_info)
+
+    set(CMAKE_FOLDER "${CMAKE_FOLDER}/third_party")
+
+    if(NOT ${skiptests} AND NOT TARGET gtest)
+        set(BUILD_GMOCK OFF)
+        set(INSTALL_GTEST OFF)
+        add_subdirectory(external/third_party/googletest EXCLUDE_FROM_ALL SYSTEM)
+    endif()
+
+    if (NOT skipvulkan)
+        add_subdirectory(external/third_party/Vulkan-Headers EXCLUDE_FROM_ALL SYSTEM)
+    endif()
+endblock()
+
+add_subdirectory(source/third_party/AmdVkExt SYSTEM)
 if (WIN32)
     add_subdirectory(source/third_party/AmdDxExt SYSTEM)
 endif()
@@ -62,6 +69,28 @@ else()
     add_compile_options(-Wall -Werror)
 endif()
 
+add_library(GPUPerfAPI-Headers INTERFACE)
+add_library(AMD::GPUPerfAPI-Headers ALIAS GPUPerfAPI-Headers)
+target_sources(GPUPerfAPI-Headers PUBLIC
+    FILE_SET HEADERS
+    BASE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/include/
+    FILES
+        ${CMAKE_CURRENT_SOURCE_DIR}/include/gpu_performance_api/gpu_perf_api.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/include/gpu_performance_api/gpu_perf_api_counters.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/include/gpu_performance_api/gpu_perf_api_functions.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/include/gpu_performance_api/gpu_perf_api_function_types.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/include/gpu_performance_api/gpu_perf_api_interface_loader.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/include/gpu_performance_api/gpu_perf_api_stub.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/include/gpu_performance_api/gpu_perf_api_types.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/include/gpu_performance_api/gpu_perf_api_vk.h
+)
+
+if (PROJECT_IS_TOP_LEVEL)
+    # Used to verify that all headers in a target's PUBLIC and INTERFACE header sets can be included on their own.
+    # This is a helpful test to ensure users of the library can include the headers without needing to worry about include order or missing includes.
+    set_target_properties(GPUPerfAPI-Headers PROPERTIES VERIFY_INTERFACE_HEADER_SETS ON)
+endif()
+
 add_subdirectory(source)
 
 set(CPACK_ARCHIVE_COMPONENT_INSTALL ON)

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016-2025 Advanced Micro Devices, Inc. All rights reserved.
+Copyright Advanced Micro Devices, Inc. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

NOTICES.txt

@@ -11,14 +11,14 @@ The above copyright notice and this permission notice (including the next paragr
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 AMD copyrighted code (BSD-2-Clause)
-Copyright (c) 2012 Advanced Micro Devices, Inc. All rights reserved.
+Copyright Advanced Micro Devices, Inc. All rights reserved.
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 AMD copyrighted code (MIT)
-Copyright (c) 2016-2018 Advanced Micro Devices, Inc. All rights reserved.
+Copyright Advanced Micro Devices, Inc. All rights reserved.
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.