Update docuemntation for V2.3

GPUOpen-Tools · Sep 30, 2024 · de8466d · de8466d
1 parent 9add69a
commit de8466d
Show file tree

Hide file tree

Showing 26 changed files with 81 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -20,8 +20,8 @@ In order to use the latest features of RGP, it is strongly recommended that user
    * Help web pages can be accessed from the **Help** button in the Radeon Developer Panel
    * Help web pages can be accessed from the Welcome screen in the Radeon GPU Profiler, or from the **Help** menu
    * The documentation is hosted publicly at:
-     * https://radeon-developer-panel.readthedocs.io/en/latest/
-     * https://radeon-gpuprofiler.readthedocs.io/en/latest/
+     * https://gpuopen.com/manuals/rdp_manual/rdp_manual-index/
+     * https://gpuopen.com/manuals/rgp_manual/rgp_manual-index/
 
 ## Graphics APIs, RDNA™ hardware, and operating systems
 ### Supported APIs
@@ -38,6 +38,7 @@ In order to use the latest features of RGP, it is strongly recommended that user
 * Windows® 10
 * Windows® 11
 * Ubuntu 22.04 LTS (Vulkan only)
+* Ubuntu 24.04 LTS (Vulkan only)
 
 
 ## Compute APIs, RDNA hardware, and operating systems

diff --git a/RELEASE_NOTES.txt b/RELEASE_NOTES.txt
@@ -1,14 +1,15 @@
-Radeon™ GPU Profiler V2.2 07-01-2024
+Radeon™ GPU Profiler V2.3 10-01-2024
 -------------------------------------
 
-V2.2 Changes
+V2.3 Changes
 -------------------------------------
 
-1) Updated to use Qt 6.7.0
-2) Fix a crash when loading a RADV-exported profile (https://github.com/GPUOpen-Tools/radeon_gpu_profiler/issues/98)
-3) Enabling shader instrumentation (to support showing thread divergence in the ray tracing shader table UI) for Vulkan® is now supported starting with 24.10-based drivers
-4) Reduced profile load time for certain profiles, especially for those captured on RDNA™ 3 hardware
-5) Bug/stability fixes
+1) The System information pane (which has been renamed from "Device configuration") will now indicate if any driver experiments were enabled when the loaded profile data set was captured
+2) The event tree view in the Event timing and Pipeline state panes will show when multiple indirect draw calls or dispatches are launched from a single ExecuteIndirect call
+3) Adapt to changes in the way that ray tracing pipelines are compiled by the ray tracing runtime and the shader compiler. This results in minor changes in the display names of the individual shaders in the RGP UI. The UI elements affected are the ray tracing shader table in the Pipeline state pane and the "Export name" drop down and the "Call targets" table in the Instruction timing pane.
+4) Fix an issue when attempting to scroll horizontally using the input device when the mouse cursor is over select rows in the Wavefront occupancy pane (https://github.com/GPUOpen-Tools/radeon_gpu_profiler/issues/79)
+5) Fix an issue where the last column in the Barriers pane is not visible at lower resolutions (https://github.com/GPUOpen-Tools/radeon_gpu_profiler/issues/103)
+6) Bug/stability fixes
 
 Known Issues
 -------------------------------------
@@ -22,15 +23,14 @@ Known Issues
 
 * Windows®
 
-1)  D3D12 command list calls of ExecuteIndirect() may show in RGP as multiple compute events.
-2)  Some Radeon Software hotkeys may conflict with Radeon GPU Profiler shortcut keys. The Radeon Software hotkeys can be reconfigured by opening the Radeon Software panel (from the system tray), selecting the Hotkeys tab under Settings then changing or unbinding any conflicting hotkeys.
-3)  If a DirectX® 12 profile is missing GPU synchronization primitive data (i.e. signals and waits) on the Frame summary pane, please try running the included scripts\AddUserToGroup.bat batch file and then recapturing the profile. This batch file must be run as Administrator.
+1)  Some Radeon Software hotkeys may conflict with Radeon GPU Profiler shortcut keys. The Radeon Software hotkeys can be reconfigured by opening the Radeon Software panel (from the system tray), selecting the Hotkeys tab under Settings then changing or unbinding any conflicting hotkeys.
+2)  If a DirectX® 12 profile is missing GPU synchronization primitive data (i.e. signals and waits) on the Frame summary pane, please try running the included scripts\AddUserToGroup.bat batch file and then recapturing the profile. This batch file must be run as Administrator.
 
 * Linux®
 
-1)  Installations of Ubuntu 20.04 or newer may have the RADV open source Vulkan driver installed by default on the system. As a result, after an amdgpu-pro driver install, the default Vulkan ICD may be the RADV ICD. In order to capture a profile, Vulkan applications must be using the amdgpu-pro Vulkan ICD. The default Vulkan ICD can be overridden by setting the following environment variable before launching a Vulkan application: VK_ICD_FILENAMES=/etc/vulkan/icd.d/amd_icd64.json
+1)  Installations of Ubuntu 20.04 or newer may have the RADV open source Vulkan® driver installed by default on the system. As a result, after an amdgpu-pro driver install, the default Vulkan ICD may be the RADV ICD. In order to capture a profile, Vulkan applications must be using the amdgpu-pro Vulkan ICD. The default Vulkan ICD can be overridden by setting the following environment variable before launching a Vulkan application: VK_ICD_FILENAMES=/etc/vulkan/icd.d/amd_icd64.json
 
-* RDNA
+* RDNA™
 
 1)  The Device configuration does not show the correct Work group processor per Shader engine for certain parts with harvested CUs.
 
@@ -42,6 +42,15 @@ Known Issues
 Release Notes History
 -------------------------------------
 
+V2.2 Changes
+-------------------------------------
+
+1) Updated to use Qt 6.7.0
+2) Fix a crash when loading a RADV-exported profile (https://github.com/GPUOpen-Tools/radeon_gpu_profiler/issues/98)
+3) Enabling shader instrumentation (to support showing thread divergence in the ray tracing shader table UI) for Vulkan is now supported starting with 24.10-based drivers
+4) Reduced profile load time for certain profiles, especially for those captured on RDNA 3 hardware
+5) Bug/stability fixes
+
 V2.1 Changes
 -------------------------------------
 
@@ -79,7 +88,7 @@ V1.16 Changes
 * Radeon GPU Profiler
 
 1)  Support for additional AMD RDNA 3 hardware
-2)  The vertical scroll bars in the ISA disassembly view (in Instruction timing and Pipeline state panes) now indicate the location of search matches and instruction latency hotspot
+2)  The vertical scroll bars in the ISA disassembly view (in the Instruction timing and Pipeline state panes) now indicate the location of search matches and instruction latency hotspot
 3)  Added support for showing the ray tracing pipeline in the Pipeline state pane for profiles generated by the RADV driver (the bulk of this work was implemented by the RADV team, but this RGP release contains some corresponding changes to support this)
 4)  The Output Merger (OM) Pipeline state pane now shows the Stencil reference value as part of the Depth/Stencil state
 5)  The Output Merger (OM) Pipeline state pane now shows the correct value for "Alpha to coverage enable" on recent hardware
@@ -541,5 +550,3 @@ V1.01 Changes
 * Radeon GPU Profiler
 
 1) Fixed crash when loading certain profiles
-
-
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -56,9 +56,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'2.2.0'
+version = u'2.3.0'
 # The full version, including alpha/beta/rc tags.
-release = u'2.2.0'
+release = u'2.3.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/source/events_windows.rst b/docs/source/events_windows.rst
@@ -163,7 +163,7 @@ The description of each counter can be viewed by hovering the mouse over the
 counter name in the legend left of the counter graph.
 
 The sizes of the L0, L1 and L2 caches, which may vary depending on the GPU, are
-reported in the Device configuration pane in the Overview tab.
+reported in the System information pane in the Overview tab.
 
 Users may use the legend on the left to choose which counters to
 include in the graph.
@@ -582,6 +582,14 @@ Grouping by hardware context is shown below:
 
 .. image:: media_rgp/rgp_event_timing_2.png
 
+Note that when profiling an application that uses indirect drawing via the
+**ExecuteIndirect** D3D12 call, the event tree view will logically group the
+individual draw calls under the same parent node. This can be seen below where
+the individidual **DrawInstanced** events are grouped under a parent node with
+the same name:
+
+.. image:: media_rgp/rgp_event_treeview_multidraw.png
+
 **Color modes**
 
 The events can be rendered using different color schemes in the same manner

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -79,6 +79,8 @@ Graphics APIs, RDNA hardware, and operating systems
 
 -  Ubuntu 22.04 LTS (Vulkan only)
 
+-  Ubuntu 24.04 LTS (Vulkan only)
+
 Compute APIs, RDNA hardware, and operating systems
 --------------------------------------------------
 

diff --git a/docs/source/media_rgp/rgp_barriers_1.png b/docs/source/media_rgp/rgp_barriers_1.png
diff --git a/docs/source/media_rgp/rgp_context_rolls_1.png b/docs/source/media_rgp/rgp_context_rolls_1.png
diff --git a/docs/source/media_rgp/rgp_context_rolls_2.png b/docs/source/media_rgp/rgp_context_rolls_2.png
diff --git a/docs/source/media_rgp/rgp_dark_theme_frame_summary_pane.png b/docs/source/media_rgp/rgp_dark_theme_frame_summary_pane.png
diff --git a/docs/source/media_rgp/rgp_device_configuration.png b/docs/source/media_rgp/rgp_device_configuration.png
diff --git a/docs/source/media_rgp/rgp_driver_experiments_notification.png b/docs/source/media_rgp/rgp_driver_experiments_notification.png
diff --git a/docs/source/media_rgp/rgp_event_treeview_multidraw.png b/docs/source/media_rgp/rgp_event_treeview_multidraw.png
diff --git a/docs/source/media_rgp/rgp_frame_summary_1.png b/docs/source/media_rgp/rgp_frame_summary_1.png
diff --git a/docs/source/media_rgp/rgp_frame_summary_2.png b/docs/source/media_rgp/rgp_frame_summary_2.png
diff --git a/docs/source/media_rgp/rgp_keyboard_shortcuts_settings.png b/docs/source/media_rgp/rgp_keyboard_shortcuts_settings.png
diff --git a/docs/source/media_rgp/rgp_most_expensive_events_1.png b/docs/source/media_rgp/rgp_most_expensive_events_1.png
diff --git a/docs/source/media_rgp/rgp_pipeline_summary_1.png b/docs/source/media_rgp/rgp_pipeline_summary_1.png
diff --git a/docs/source/media_rgp/rgp_profile_summary_2.png b/docs/source/media_rgp/rgp_profile_summary_2.png
diff --git a/docs/source/media_rgp/rgp_rdc_interop_2.png b/docs/source/media_rgp/rgp_rdc_interop_2.png
diff --git a/docs/source/media_rgp/rgp_render_targets_overview_1.png b/docs/source/media_rgp/rgp_render_targets_overview_1.png
diff --git a/docs/source/media_rgp/rgp_render_targets_overview_2.png b/docs/source/media_rgp/rgp_render_targets_overview_2.png
diff --git a/docs/source/media_rgp/rgp_render_targets_overview_3.png b/docs/source/media_rgp/rgp_render_targets_overview_3.png
diff --git a/docs/source/media_rgp/rgp_system_information.png b/docs/source/media_rgp/rgp_system_information.png
diff --git a/docs/source/overview_windows.rst b/docs/source/overview_windows.rst
@@ -503,8 +503,8 @@ The screen is split into two sections, a timeline view and a tree view listing:
 .. image:: media_rgp/rgp_render_targets_overview_2.png
 
 The graphical timeline view illustrates the usage of render targets over
-the duration of the frame. Other events like dispatches, copies, clears
-and barriers are shown at the bottom of this view.
+the duration of the frame. Other events like dispatches, ray trace dispatches,
+copies, clears and barriers are shown at the bottom of this view.
 
 Zoom controls can be used to focus in on a section of the timeline. More
 information on zoom controls can be found under the
@@ -648,15 +648,20 @@ to quickly navigate to the event in other panes.
 .. image:: media_rgp/rgp_pipeline_summary_5.png
 
 
-Device configuration
---------------------
+System information
+------------------
 
-This UI reports the GPU configuration of the system that was used to
-generate the profile. The Radeon Developer Panel can retrieve profiles
-from remote systems so the GPU details can be different from the system
-that you are using to view the data. The clock frequencies refer to the
+This UI reports the configuration of the system that was used to
+generate the profile. The Radeon Developer Panel can capture profiles
+on remote systems so the system details can be different from the system
+that you are using to view the data. The GPU clock frequencies refer to the
 clock frequency running when the capture was taken. The number in
 parentheses represents the peak clock frequency the graphics hardware
 can run at.
 
-.. image:: media_rgp/rgp_device_configuration.png
+In addition, if any driver experiments were enabled when the profile was captured
+they will be displayed here under the section labeled **Driver experiments**.
+Hovering over a driver experiment name or value with the mouse pointer displays a
+tooltip describing that item.
+
+.. image:: media_rgp/rgp_system_information.png
diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
@@ -10,7 +10,7 @@ provided with this distribution for information on how to capture a profile.
 This can be obtained from within the Radeon Developer Panel or from the
 link on the Radeon GPU Profiler "Welcome" view. The Radeon Developer Panel
 documentation can also be viewed online at:
-https://radeon-developer-panel.readthedocs.io/en/latest/
+https://gpuopen.com/manuals/rdp_manual/rdp_manual-index/
 
 Starting the Radeon GPU Profiler
 --------------------------------
@@ -96,7 +96,7 @@ the profile data are within the **Overview** and **Events** sections.
 
    g. **Pipelines** - Details of the pipeline usage in the profile.
 
-   h. **Device configuration** - Information about the GPU the profile
+   h. **System information** - Information about the GPU the profile
       was generated on.
 
 3. **Events**
@@ -121,4 +121,26 @@ the profile data are within the **Overview** and **Events** sections.
    b. **Themes and colors** - Customize colors for graphics API and
       hardware data.
 
-   c. **Keyboard shortcuts** - Shortcuts for navigating various parts of the UI.
+   c. **Keyboard shortcuts** - Shortcuts for navigating various parts of the UI.
+
+Driver experiments
+------------------
+
+Driver experiments can be configured when capturing a profile and allow the
+behavior of certain driver operations to be adjusted.  Please see the Radeon
+Developer Panel documentation for more details on configuring Driver experiments.
+Modified Driver experiments included in a profile will be listed on the System
+information pane under the section labeled **Driver experiments**. 
+
+.. image:: media_rgp/rgp_system_information.png
+
+When a profile that includes Driver experiments is loaded, a notification
+banner is displayed below the main drop down menu. 
+
+.. image:: media_rgp/rgp_driver_experiments_notification.png
+
+The notification banner includes a "See details" shortcut link that navigates
+to the System information pane. The banner can be dismissed by clicking the "X"
+button. Clicking the "Do not show again" link prevents the banner from being
+shown for subsequently loaded trace files. The notification banner can be
+re-enabled from the Settings pane.
diff --git a/docs/source/settings.rst b/docs/source/settings.rst
@@ -30,6 +30,10 @@ GPU Analyzer. See the section
 :ref:`Radeon GPU Analyzer and Radeon GPU Profiler interop<rga_rgp_interop>`
 for more information.
 
+**Driver experiment notification** Radeon GPU Profiler will display a
+notification banner under the main drop down menu of the user interface
+indicating when a loaded profile contains modified driver experiments.
+
 Themes and colors
 -----------------
 The profiler makes heavy use of coloring to display its information.
-Original file line number
+Diff line change
@@ Expand Up / @@ -79,6 +79,8 @@ Graphics APIs, RDNA hardware, and operating systems @@
     -  Ubuntu 22.04 LTS (Vulkan only)
+    -  Ubuntu 24.04 LTS (Vulkan only)
     Compute APIs, RDNA hardware, and operating systems
     --------------------------------------------------
@@ Expand Down @@