Update build and readme

Author: amitprakash07

BUILD.md

@@ -25,22 +25,22 @@ order to clone/update any dependent repositories.
       * `pip install sphinxcontrib-spelling`
 
 #### Instructions
- * Simply execute the [PreBuild.py](PreBuild.py) python script located in the GPA directory:
-   * `python PreBuild.py`
+ * Simply execute the [pre_build.py](build/pre_build.py) python script located in the GPA directory:
+   * `python build/pre_build.py`
  * This script will clone any dependent repositories that are not present on the system. If any of the dependent repositories are already
 present on the system, this script will instead do a "git pull" on those repositories to ensure that they are up to date. Please re-run
 this script everytime you pull new changes from GPA repository.
- * NOTE: For GPA 3.3 or newer, if you are updating an existing clone of the GPA repo from a GPA release prior than 3.3, you will first need to delete the Common/Lib/Ext/GoogleTest directory. Starting with GPA 3.3, GPA is now using a fork of the official GoogleTest repo. Failure to remove this directory will lead to git errors when running PreBuild.py or UpdateCommon.py.
+ * NOTE: For GPA 3.3 or newer, if you are updating an existing clone of the GPA repo from a GPA release prior than 3.3, you will first need to delete the Common/Lib/Ext/GoogleTest directory. Starting with GPA 3.3, GPA is now using a fork of the official GoogleTest repo. Failure to remove this directory will lead to git errors when running [pre_build.py](build/pre_build.py) or [fetch_dependencies.py](scripts/fetch_dependencies.py).
  * This script will also download and execute the Vulkan� SDK installer.
    * On Windows, running the installer may require elevation.  If you've previously installed the required Vulkan version, UpdateCommon will simply copy the files form the default installation location into the correct place into the GPUPerfAPI directory tree.
    * UpdateCommon is set up to install the version of the Vulkan SDK which was used during development. If you want to use a newer version of the SDK, the following file will need to be updated:
-     * [UpdateCommonMap.py](Scripts/UpdateCommonMap.py)
+     * [fetch_dependencies.py](scripts/fetch_dependencies.py)
    * By default the build will expect the Vulkan SDK to be found in a directory pointed to by the `VULKAN_SDK` environment variable. This environment variable is automatically set by the Windows SDK installer, but you may need to set it manually after running the Linux SDK installer. The Linux SDK includes a script called `setup-env.sh` to aid in setting this environment variable:
      * `source ~/VulkanSDK/1.0.68.0/setup-env.sh` (adjust path as necessary)
  * This script also executes cmake to generate all required files to build GPA.
- * If you want to generate all cmake build files without trying to clone/pull dependent repos, you can add "--nofetch" to the PreBuild.py command line.
- * Additional switches that can be used with the PreBuild.py script:
-   * `--vs=[2015,2017]`: Specify the Visual Studio version for which to generate projects. Default is 2017.
+ * If you want to generate all cmake build files without trying to clone/pull dependent repos, you can add "--nofetch" to the [pre_build.py](build/pre_build.py) command line.
+ * Additional switches that can be used with the [pre_build.py](build/pre_build.py) script:
+   * `--vs=[2015,2017,2019]`: Specify the Visual Studio version for which to generate projects. Default is 2017.
     * `--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.
    * `--platform=[x86,x64]`: Specify the platform for which to generate build files. Default is both.
    * `--clean`: Deletes CMakeBuild directory and regenerates all build files from scratch
@@ -63,14 +63,14 @@ this script everytime you pull new changes from GPA repository.
  * Microsoft .NET 4.6.2 SDK from https://www.microsoft.com/en-us/download/details.aspx?id=53321
 
 ##### Build Instructions
- * Load CMakeBuild\x64\GPUPerfAPI.sln into Visual Studio to build the 64-bit version of GPA
- * Load CMakeBuild\x86\GPUPerfAPI.sln into Visual Studio to build the 32-bit version of GPA
+ * Load cmake_bld\x64\GPUPerfAPI.sln into Visual Studio to build the 64-bit version of GPA
+ * Load cmake_bld\x86\GPUPerfAPI.sln into Visual Studio to build the 32-bit version of GPA
  * After a successful build, the GPUPerfAPI binaries can be found in `GPA\Output\$(Configuration)` (for example GPA\Output\Release)
 
 #### Additional Information
  * The Windows projects each include a .rc file that embeds the VERSIONINFO resource into the final binary. Internally within AMD, a Jenkins build system will dynamically update
-   the build number. The version and build numbers can be manually updated by modifying the [GPAVersion.h](Src/GPUPerfAPI-Common/GPAVersion.h) file.
- * When building the internal version (using the --internal switch when calling PreBuild.py), each binary filename will have a "-Internal" suffix (for example GPUPerfAPIDX11-x64-Internal.dll)
+   the build number. The version and build numbers can be manually updated by modifying the [gpa_version.h](source/gpu_perf_api_common/gpa_version.h) file.
+ * When building the internal version (using the --internal switch when calling [pre_build.py](build/pre_build.py), each binary filename will have a "-Internal" suffix (for example GPUPerfAPIDX11-x64-Internal.dll)
 
 ## Linux Build Information
 
@@ -79,18 +79,18 @@ this script everytime you pull new changes from GPA repository.
  * For 32-bit builds, install the multilib packages: sudo apt-get install gcc-multilib g++-multilib
 
 ##### Build Instructions
- * Execute "make" in the CMakeBuild/x64/debug to build the 64-bit debug version of GPA
- * Execute "make" in the CMakeBuild/x64/release to build the 64-bit release version of GPA
- * Execute "make" in the CMakeBuild/x86/debug to build the 32-bit debug version of GPA
- * Execute "make" in the CMakeBuild/x86/release to build the 32-bit release version of GPA
+ * Execute "make" in the cmake_bld/x64/debug to build the 64-bit debug version of GPA
+ * Execute "make" in the cmake_bld/x64/release to build the 64-bit release version of GPA
+ * Execute "make" in the cmake_bld/x86/debug to build the 32-bit debug version of GPA
+ * Execute "make" in the cmake_bld/x86/release to build the 32-bit release version of GPA
  * After a successful build, the GPUPerfAPI binaries can be found in `GPA/Output/$(Configuration)` (for example GPA/Output/release)
  * When building the internal version, each binary filename will also have a "-Internal" suffix (for example libGPUPerfAPIGL-Internal.so)
 
 ## PublicCounterCompiler Tool
 
 The PublicCounterCompiler Tool is a utility, written in C#, that will generate C++ code to define the public (or derived) counters.
-It takes as input text files contained in the [PublicCounterCompilerInputFiles](Src/PublicCounterCompilerInputFiles) directory and
-outputs files in the [GPUPerfAPICounterGenerator](Src/AutoGenerated/GPUPerfAPICounterGenerator), [GPUPerfAPIUnitTests](Src/AutoGenerated/GPUPerfAPIUnitTests)
+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:
@@ -107,7 +107,7 @@ There are three ways to execute the tool:
   * Param 6: GPU - the GPU to take the counter names from (ex: Gfx9)
   * Param 7: GPU ASIC - (optional) the subversion of GPU to take the counter names from
 
-See the various PublicCounterDefinitions/*.txt files in the [PublicCounterCompilerInputFiles](Src/PublicCounterCompilerInputFiles) directory. These contain all the counter definitions.
+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.
 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:
@@ -118,4 +118,4 @@ Counter formulas are expressed in a Reverse Polish Notation and are made up the
 * functions: The supported functions are: min, max, sum, ifnotzero, and vcomparemax4. "max and "sum" have variants that work on multiple items at once (i.e. sum16, sum64, etc.)
 * hardware params: The supported hardware params are "num_shader_engines". "num_simds", "su_clock_prim", "num_prim_pipes", and "TS_FREQ"
 
-For more details, see the "EvaluateExpression" function in the [GPADerivedCounters.cpp](Src/GPUPerfAPICounterGenerator/GPADerivedCounters.cpp) file.
+For more details, see the "EvaluateExpression" function in the [gpa_derived_counter.cc](source/gpu_perf_api_counter_generator/gpa_derived_counter.cc) file.

README.md

@@ -49,32 +49,33 @@ Prebuilt binaries can be downloaded from the Releases page: https://github.com/G
 
 ## Cloning the Repository
 To clone the GPA repository, execute the following git command
-  * git clone https://github.com/GPUOpen-Tools/GPA.git
+  * git clone https://github.com/GPUOpen-Tools/gpu_performance_api
 
 After cloning the repository, please run the following python script to retrieve the required dependencies and generate the build files (see [BUILD.md](BUILD.md) for more information):
   * python PreBuild.py
 
 ## Source Code Directory Layout
-* [CMakeModules](CMakeModules) -- Common modules used in the CMake build system
-* [docs](docs) -- contains documentation sources and a Doxygen configuration file
-* [Src/AutoGenerated](Src/AutoGenerated) -- contains auto-generated source code used when building GPUPerfAPI
-* [Src/Examples](Src/Examples) -- contains the source code for a DirectX 12, DirectX 11, Vulkan and OpenGL sample which use GPUPerfAPI
-* [Src/GPUPerfAPI-Common](Src/GPUPerfAPI-Common) -- contains source code for a Common library shared by all versions of GPUPerfAPI
-* [Src/GPUPerfAPICL](Src/GPUPerfAPICL) -- contains the source for the OpenCL™ version of GPUPerfAPI
-* [Src/GPUPerfAPICounterGenerator](Src/GPUPerfAPICounterGenerator) -- contains the source code for a Common library providing all counter data
-* [Src/GPUPerfAPICounters](Src/GPUPerfAPICounters) -- contains the source code for a library that can be used to query counters without an active GPUPerfAPI context
-* [Src/GPUPerfAPIDX](Src/GPUPerfAPIDX) -- contains source code shared by the DirectX versions of GPUPerfAPI
-* [Src/GPUPerfAPIDX11](Src/GPUPerfAPIDX11) -- contains the source for the DirectX11 version of GPUPerfAPI
-* [Src/GPUPerfAPIDX12](Src/GPUPerfAPIDX12) -- contains the source for the DirectX12 version of GPUPerfAPI
-* [Src/GPUPerfAPIGL](Src/GPUPerfAPIGL) -- contains the source for the OpenGL version of GPUPerfAPI
-* [Src/GPUPerfAPIUnitTests](Src/GPUPerfAPIUnitTests) -- contains a small set of unit tests for GPUPerfAPI
-* [Src/GPUPerfAPIVk](Src/GPUPerfAPIVk) -- contains the source for the Vulkan version of GPUPerfAPI
-* [Src/PublicCounterCompiler](Src/PublicCounterCompiler) -- source code for a tool to generate C++ code for public counters from text files defining the counters.
-* [Src/PublicCounterCompilerInputFiles](Src/PublicCounterCompilerInputFiles) -- input files that can be fed as input to the PublicCounterCompiler tool
-* [Scripts](Scripts) -- scripts to use to clone/update dependent repositories
+* [build](build) -- contains build scripts and cmake build modules
+* [docs](docs) -- contains sphinx documentation sources and a Doxygen configuration file
+* [include](include) -- contains GPUPerfAPI public headers
+* [scripts](scripts) -- scripts to use to clone/update dependent repositories
+* [source/auto_generated](source/auto_generated) -- contains auto-generated source code used when building GPUPerfAPI
+* [source/examples](source/examples) -- contains the source code for a DirectX 12, DirectX 11, Vulkan and OpenGL sample which use GPUPerfAPI
+* [source/gpu_perf_api_common](source/gpu_perf_api_common) -- contains source code for a Common library shared by all versions of GPUPerfAPI
+* [source/gpu_perf_api_cl](source/gpu_perf_api_cl) -- contains the source for the OpenCL™ version of GPUPerfAPI
+* [source/gpu_perf_api_counter_generator](source/gpu_perf_api_counter_generator) -- contains the source code for a Common library providing all counter data
+* [source/gpu_perf_api_counters](source/gpu_perf_api_counters) -- contains the source code for a library that can be used to query counters without an active GPUPerfAPI context
+* [source/gpu_perf_api_dx](source/gpu_perf_api_dx) -- contains source code shared by the DirectX versions of GPUPerfAPI
+* [source/gpu_perf_api_dx11](source/gpu_perf_api_dx11) -- contains the source for the DirectX11 version of GPUPerfAPI
+* [source/gpu_perf_api_dx12](source/gpu_perf_api_dx12) -- contains the source for the DirectX12 version of GPUPerfAPI
+* [source/gpu_perf_api_gl](source/gpu_perf_api_gl) -- contains the source for the OpenGL version of GPUPerfAPI
+* [source/gpu_perf_api_unit_tests](source/gpu_perf_api_unit_tests) -- contains a small set of unit tests for GPUPerfAPI
+* [source/gpu_perf_api_vk](source/gpu_perf_api_vk) -- contains the source for the Vulkan version of GPUPerfAPI
+* [source/public_counter_compiler](source/public_counter_compiler) -- source code for a tool to generate C++ code for public counters from text files defining the counters.
+* [source/public_counter_compiler_input_files](source/public_counter_compiler_input_files) -- input files that can be fed as input to the PublicCounterCompiler tool
 
 ## Documentation
-The documentation for GPUPerfAPI can be found in each [GitHub release](https://github.com/GPUOpen-Tools/GPA/releases). In the release .zip file or .tgz file, there
+The documentation for GPUPerfAPI can be found in each [GitHub release](https://github.com/GPUOpen-Tools/gpu_performance_api/releases). In the release .zip file or .tgz file, there
 will be a "docs" directory. Simply open the index.html file in a web browser to view the documentation.
 
 The documentation is hosted publicly at: http://gpuperfapi.readthedocs.io/en/latest/

ReleaseNotes.md

@@ -1,7 +1,7 @@
 # GPU Performance API Release Notes
 ---
 
-## Version 3.6 (05/14/20)
+## Version 3.6 (05/15/20)
   * Add support for additional GPUs and APUs, including AMD Ryzen™ 4000 Series APUs.
   * Add two new GFX10 GlobalMemory Counters for graphics using DX12 and Vulkan: LocalVidMemBytes and PcieBytes.
   * Add VS2019 project support to CMake.