Update documentation for v1.9 release

Author: ahosier

.gitignore

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

LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2023 Advanced Micro Devices, Inc.
+Copyright (c) 2017-2024 Advanced Micro Devices, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

RELEASE_NOTES.txt

@@ -1,11 +1,15 @@
-Radeon™ Memory Visualizer V1.8 12/07/2023
+Radeon™ Memory Visualizer V1.9 04/24/2024
 -----------------------------------------
 
-V1.8 Changes
+V1.9 Changes
 ------------------------------------
-1) The Resource usage size timeline calculations take resource aliasing into account.
-2) Unbound memory sizes are included on the Resource usage size timeline.
-3) Bug/stability fixes.
+1) Improved resource list sorting.
+2) Implicit resource detection for heap resources.
+3) Conversion of heaps to resource buffers disabled if implicit heap detection is available.
+4) Improved "Filter by size" sliders shown with min and max values.
+5) Named virtual allocations.
+6) The default timeline has been changed to "Virtual memory heap" and the "Committed memory" timeline view has been removed.
+7) Bug/stability fixes.
 
 Known Issues
 ------------------------------------
@@ -25,6 +29,12 @@ Known Issues
 Release Notes History
 ------------------------------------
 
+V1.8 Changes
+------------------------------------
+1) The Resource usage size timeline calculations take resource aliasing into account.
+2) Unbound memory sizes are included on the Resource usage size timeline.
+3) Bug/stability fixes.
+
 V1.7 Changes
 ------------------------------------
 1) Aliased Resource size calculation improvements on Resource overview pane.

documentation/source/allocation_explorer.rst

@@ -30,3 +30,4 @@ The table under the allocation display shows a list of all the resources in the
 chosen allocation. These resources can be filtered using the search box text
 filter and also by size using the "**Filter by size**" slider on the right.
 Double-clicking on a resource will navigate to the **Resource details** pane.
+

documentation/source/allocation_overview.rst

@@ -48,3 +48,4 @@ box. This way, allocations can be filtered by size, heap type or number of
 resources.
 
 Double-clicking on a resource will jump to the **Allocation explorer**.
+

documentation/source/carousel.rst

@@ -16,6 +16,10 @@ The **Committed memory** shows the amount of memory that this application has
 committed to physical memory for each of the heap types. Ideally, all memory
 that the application has requested should be in physical memory.
 
+Note that the amount of committed memory displayed across different tabs of RMV is calculated
+based on low-level data from the graphics driver and may not directly correspond to memory allocations/deallocations
+made using the graphics API.
+
 .. image:: media/snapshot/carousel_committed_memory.png
 
 The **Requested virtual memory** shows which memory was requested from which heap.
@@ -39,3 +43,4 @@ memory, this will be seen in the *Allocation overview* pane for each allocation.
 
 The carousel is also shown in the **Snapshot delta** pane but here it shows the
 differences between the 2 selected snapshots.
+

documentation/source/conf.py

@@ -46,17 +46,17 @@
 
 # General information about the project.
 project = u'Radeon Memory Visualizer'
-copyright = u'2018-2023, Advanced Micro Devices, Inc. All rights reserved'
+copyright = u'2018-2024, Advanced Micro Devices, Inc. All rights reserved'
 author = u'AMD Developer Tools'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'1.8.0'
+version = u'1.9.0'
 # The full version, including alpha/beta/rc tags.
-release = u'1.8.0'
+release = u'1.9.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

documentation/source/heap_overview.rst

@@ -35,24 +35,21 @@ mean the application gets it. If the application requests too much memory,
 a warning message is displayed. The bar is also color coded to show whether
 the memory type is oversubscribed or is close to being oversubscribed.
 
-The 'total size' bar shows the total amount of physical memory in the heap.
+The **"Total size"** bar shows the total amount of physical memory in the heap.
 
-The "Requested" bar shows how much memory the application has requested. This
+The **"Requested"** bar shows how much memory the application has requested. This
 should give an indication of the memory footprint of the application.
+Memory is requested when allocations are made e.g. by creating ``ID3D12Heap`` (D3D12)
+or ``VkDeviceMemory`` (Vulkan).
 Memory requests typically request virtual memory under the hood and it is up
 to the driver to make sure that virtual memory is mapped to physical memory
 when and where appropriate.
+An allocation may not appear in RMV until a first resource is placed in it.
 
-The "Bound" bar shows how much memory has been bound to resources. If there is
+The **"Bound"** bar shows how much memory has been bound to resources, e.g. buffers or textures (images). If there is
 substantially more requested memory than bound memory, it may indicate that
 memory has been requested but is not actually being used by the application.
 
-The "Committed" bar shows how much memory has been mapped to physical memory.
-If the amount of committed memory is substantially less than the amount of
-memory requested, it may indicate that there are other tasks running on the
-system that are consuming memory or the application itself is using more
-memory than is physically available.
-
 The middle column shows a series of statistics for the heap memory type, such
 as where the memory resides (in system or video memory), whether it is mapped
 on the CPU and some statistics on the allocations.
@@ -61,3 +58,4 @@ The right column shows the makeup of the resource types in each of the heaps.
 From this, it can be determined if certain resource types are in the optimum
 memory type for the particular resource (maybe there's a render target in system
 memory when ideally it should be in local memory).
+

documentation/source/index.rst

@@ -50,8 +50,8 @@ How to load a trace
 
 There are a few ways to load a trace into RMV.
 
-1) Use the “File/Open trace” pull down menu, or the “File/Recent
-   trace” pull down menu item.
+1) Use the "File/Open trace" pull down menu, or the "File/Recent
+   trace" pull down menu item.
 
   Note that RMV is also capable of loading Radeon GPU Detective (.rgd) files.
   In order to view .rgd file names in the File open dialog box, be sure to select
@@ -61,10 +61,10 @@ There are a few ways to load a trace into RMV.
 
 .. image:: media/open_file_rgd.png
 
-2) Go to the “Welcome” view and click on the “Open a Radeon Memory
-   trace…”
+2) Go to the "Welcome" view and click on the "Open a Radeon Memory
+   trace…"
 
-3) Go to the “Welcome” view and click on a trace that you have
+3) Go to the "Welcome" view and click on a trace that you have
    previously loaded in the Recent list.
 
 .. image:: media/welcome_1.png
@@ -210,13 +210,20 @@ 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 image-based resources.  Names can be assigned to
-DirectX resources using the ID3D12Object::SetName() method.  Calling the SetName()
+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
+up by the Panel. This resource naming information is then included in the RMV trace
 file.
-
-For more information, please review the Microsoft DirectX 12 documentation.
+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
 ----------------------
@@ -251,4 +258,5 @@ Microsoft is a registered trademark of Microsoft Corporation in the US and other
 Windows is a registered trademark of Microsoft Corporation in the US and other jurisdictions.
 
 
-© 2018-2023 Advanced Micro Devices, Inc. All rights reserved.
+© 2018-2024 Advanced Micro Devices, Inc. All rights reserved.
+