The Radeon™ Memory Visualizer (RMV)

The Radeon Memory Visualizer is a memory optimization tool that can be used by developers to optimize memory usage for DirectX12©, Vulkan© applications for AMD GCN and RDNA hardware.

This document describes how the Radeon Memory Visualizer can be used to examine a memory trace file. To learn how to generate an RMV trace, please see https://radeon-developer-panel.readthedocs.io/en/latest/.

Supported graphics APIs, RDNA and GCN hardware, and operating systems

Supported APIs

  • DirectX12
  • Vulkan

Supported RDNA and GCN hardware

  • AMD Radeon™ RX 5000 series
  • AMD Radeon™ VII
  • AMD RX Vega 64 and RX Vega 56
  • AMD Ryzen™ 5 3400G/2400G and Ryzen™ 3 3200G/2200G Processors with Radeon Vega Graphics
  • AMD Radeon™ R9 Fury and Nano series
  • AMD Radeon™ RX 400 and RX 500 series
  • AMD Tonga R9 285, R9 380

Supported Operating Systems

  • Windows 10 only

Radeon Memory Visualizer - Quick Start

How to generate a memory trace

The first thing you will need to do is generate a memory trace. Currently, this is done via the Radeon Developer Panel 2.0. Read the documentation provided with this distribution for information on how to create a memory trace. This can be obtained from within the Radeon Developer Panel or from the link on the Radeon Memory Visualizer “Welcome” view.

Starting the Radeon Memory Visualizer

Start RadeonMemoryVisualizer.exe (this is the tool used to view memory trace data).

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.
  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 previously loaded in the Recent list.
_images/welcome_1.png
  1. Go to the Recent traces view to see a full list of all your recent traces.
Notice that there is additional information provided for each trace when viewed in this pane, such as the date when the trace was last accessed. It is also possible to remove recent traces from the list. Note that they will only be removed from the list; they won’t be deleted from the file system.
_images/recent_traces_1.png
  1. Drag and drop a memory trace file onto the Radeon Memory Visualizer executable, or onto an already open RMV instance.

The Radeon Memory Visualizer user interface

RMV uses the concepts of traces and snapshots. A trace is the file which has been loaded as described in the previous section. A memory trace file contains various memory-related events that happened on the GPU over time (memory allocations, deallocations, binding resources etc). A snapshot is the state of the GPU at a particular instance in time. Using snapshots, it is possible to examine which memory has been allocated and where resources can be found. It is also possible to compare snapshots to look for memory leaks. For example, a snapshot could be taken before starting a game level and another snapshot taken after completing the level. Ideally, the 2 snapshots should be the same.

There are four main menus in the Radeon Memory Visualizer and each may have a number of sub-windows..

  1. Start

    1. Welcome - Shows links to help documentation, and a list of recently opened traces, and a sample trace.
    2. Recent traces - Displays a list of the recently opened traces.
    3. About - Shows build information about RMV and useful links.
  2. Timeline

    Gives an overview of memory consumption over time. Allows for the viewing and creation of snapshots

  3. Snapshot

    1. Heap overview - Gives an overview of the heaps available and their associated properties
    2. Resource overview - Gives an overview of the total resources allocated and shows their relative sizes and types
    3. Allocation overview - Shows the resources within each allocation
    4. Resource list - Shows the properties for all the resource in all allocations
    5. Allocation explorer - Shows the resources within a chosen allocation
    6. Resource details - Display more information about a selected resource
  4. Compare

    1. Snapshot delta - Shows an overview of the differences between one snapshot and another
    2. Memory leak finder - Shows allocations from each snapshot and how those allocations intersect to help locate memory leaks

Settings

General

Check for updates If checked, the Radeon Memory Visualizer will alert you that a new version is available for download.

Themes and colors

The visualizer makes heavy use of coloring to display its information. This pane allows users to thoroughly customize those colors.

_images/themes_and_colors_1.png

Keyboard shortcuts

Here users will find the Keyboard shortcuts pane:

The Global navigation section refers to keystrokes that aid user navigation, and are always detected regardless of which pane is visible.

The Timeline controls shortcuts are specific to zooming and panning operations that can be performed within the Timeline view (see below).

The Global hotkeys section refers to any hotkeys available anywhere in the product. Currently there are hotkeys to open and close a trace file and to cycle through the different time units from any pane, rather than having to go to the settings. This allows you to view a timeline in clock cycles, milliseconds, seconds or minutes very quickly.

_images/keyboard_shortcuts_1.png

All users are encouraged to adopt these keystrokes while using RMV.

UI Navigation

In an effort to improve workflow, RMV supports keyboard shortcuts and back and forward history to quickly navigate throughout the UI.

Back and forward navigation

RMV tracks navigation history, which allows users to navigate back and forward between all of RMV’s panes. This is achieved using global navigation hotkeys shown above, or the back and forward buttons on all panes in the top left below the file menu.

Currently, back and forward navigation is restricted to pane switches.

The Timeline windows

The timeline tab shows the overview of the trace and the system.

Snapshot generation

The Snapshot generation view will be the first view shown when a memory trace file has loaded. It will show a graphical representation of the memory usage over time for a number of processes running on the system, including the application started by the user. Currently only the user’s process is available.

_images/timeline_1.png

RMV uses the concept of snapshots. A snapshot is the memory state at a particular moment in time. Using multiple snapshots, it is possible to visualize how memory is being used by an application over time. It is also possible to compare snapshots to check to see if memory is being release or whether there are memory leaks.

If snapshots were taken while recording, they will be shown as markers on the graph and in the table below the graph.

By default, the graph will be colored by resource type. A color legend below the timeline will indicate what resource these colors represent. The coloring mode can be changed by selecting from the combo box above the top-left of the timeline.

When the mouse is over the timeline, the tooltip help will show information about the memory allocated at the time corresponding to the mouse position. The time can be seen from the ruler above the graph. The most abundant resources are listed and the rest are combined in the last entry as “Other”.

Zoom controls

Zoom controls are provided for adjusting the time scale that is viewable on screen and are displayed in the top right of the timeline pane. These are:

ZoomSelectionRef Zoom to selection

When Zoom to selection is clicked, the zoom level is increased to a selected region or selected event. A selection region is set by holding down the left mouse button while the mouse is on the graph and dragging the mouse either left or right. A colored overlay will highlight the selected region on the graph. For graphs that support it, an event may be selected by clicking on it with the mouse (either the left or right button). Zoom to selection can also be activated by right clicking on a selection on the graph and choosing the Zoom to selection context menu option. Zooming to a selected event can be accomplished by simply double clicking the event. Pressing the Z shortcut key while holding down the CTRL key activates Zoom to selection as well.

ZoomResetRef Zoom reset

When Zoom reset is clicked, the zoom level is returned to the original level to reveal the entire time span on the graph. The zoom level can also be reset using the H shortcut key.

ZoomInRef Zoom in

Increases the zoom level incrementally to display a shorter time span on the graph. The zoom level is increased each time this icon is clicked until the maximum zoom level is reached. Alternatively, holding down the CTRL key and scrolling the mouse wheel up while the mouse pointer is over the graph will also zoom in for a more detailed view. Zooming in can be activated with the A shortcut key. To zoom in quickly at a 10x rate, press the S shortcut key.

ZoomOutRef Zoom out

Decreases the zoom level incrementally to display a longer time span on the graph. The zoom level is decreased each time this icon is clicked until the minimum zoom level is reached (i.e. the full available time region). Alternatively, holding down the CTRL key and scrolling the mouse wheel down while the mouse pointer is over the graph will also zoom in for more detailed view. Zooming out can be activated with the Z shortcut key. To zoom out quickly at a 10x rate, press the X shortcut key.

Zoom panning

When zoomed in on a graph region, the view can be shifted left or right by using the horizontal scroll bar. The view can also be scrolled by dragging the mouse left or right while holding down the spacebar and the left mouse button. Left and right arrow keys can be used to scroll as well.

Taking snapshots

Snapshots can be taken by right-clicking anywhere on the memory graph. This will bring up a context menu. Clicking on the context menu option “Add snapshot ..” will take a snapshot and add it to the graph and to the snapshot table below the graph. Notice that only the snapshot name is shown in the table; the other table entries will be created when the snapshot is viewed.

Clicking on the snapshot in the table or on the timeline will select that snapshot. Clicking on the SNAPSHOT tab will show further information about the selected snapshot. Double-clicking on a snapshot on the table or on the graph will jump to the Heap overview pane on the SNAPSHOT. This process will generate the snapshot data at the required time and returning back to the Snapshot generation will now show the table fully populated for the selected snapshot.

Right-clicking on a snapshot in the table will show a context menu allowing the snapshot to be renamed or deleted. Snapshots are saved back to the trace file so they can be viewed at a later date.

Two or more snapshots can be selected in the table by holding down the shift key to select a range of snapshots or pressing Ctrl to select individual snapshots. If 2 snapshots are selected, right-clicking on the table while holding down the Ctrl key will display a context menu to allow them to be compared. Alternatively, the Compare snapshots button in the top right will become active. Clicking on either will jump to the Snapshot delta pane in the COMPARE tab.

Device configuration

This pane will show some of the parameters of the video hardware on which the memory trace was taken, showing such things as the name of the video card and the memory bandwidth.

_images/device_config_1.png

Snapshot windows

These panes allow the user to analyze single snapshots. The panes can be accessed from the list on the left hand side. Below the list is a combo box which allows quick switching between different snapshots.

Heap overview

This is the default snapshot pane that will be displayed after creating a snapshot. It gives an overview of the amount of memory the application is using and where that memory is allocated. It can be used to very quickly determine if the application is using too much memory of a certain type and if the correct memory type is being used where it should be.

_images/heap_overview_1.png

The display is split into 3 sections, one section per heap type. There is a brief description of the use for each heap.

On the left is the amount of memory used for each heap type as a series of bar graphs:

The requested bar graph shows how much of that heap was requested by the application. Just because an application requests memory doesn’t automatically 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 oversubscibed or is close to being oversubscribed.

The ‘total size’ bar shows the total amount of physical memory in the heap.

The ‘used’ bar shows how much memory the application is using in dark gray. The lighter gray to the right indicates the total amound of memory used by all processes in the system.

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.

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).

Resource overview

This pane will show an overview of the resource used by the application. Most of the display is occupied by a resource view showing a graphical representation of the resources in memory. Resources can be filtered out to only show resources of a particular type or contained in a particular preferred heap. They can also be color-coded according to various attributes (by resource type or preferred heap for example).

_images/resource_overview_1.png

The preferred heap drop down list allows you to select resources you want to include in the resource view according to which heap was the preferred container for the resource at the time the resource was created. You can do this by checking one or more heaps you wish to include resources from.

The resource usage drop down allows selection of resources according to their usage type. Again, this is achieved by checking one or more resource types. For example, unbound resources are not shown by default but this can be changed.

These combo boxes appear on several of the UI’s and they are all independent ie changing heap types on one pane won’t affect the heap types on the other panes that use the heap combo box. Also, the heap selections don’t reset when switching snapshots so that comparisons can quickly be done with the same configuration. However, loading a new memory trace will reset the heap combo boxes to their default state. Currently, there are 3 heap types which are explained a little in the heap overview pane. A fourth heap type in the combo box, Unspecified is used to indicate that this resource does not have a preferred heap.

The color combo box allows you to color the display depending on various resource attributes. Examples include coloring by the resource type (the default) or coloring by resource bind or create times. Using the coloring modes allows you to instantly see the resources with the same parameters.

There are also 3 slicing combo boxes. These allow you to group resources by some attribute. The first slicing mode applies to all the resources. The other 2 slicing modes are applied to the groups set up by the previous slicing mode.

Clicking on a resource will show details about it at the bottom of the pane, including various attributes and where the selected resource lies in its corresponding allocation.

The screenshot below shows slicing and coloring resources depending whether they are in the preferred heap. You can tell instantly if resources are where you’d expect them to be and if not, investigate further by double-clicking on the resource which will jump to the Resource details pane.

_images/resource_overview_2.png

If the resource is displayed with a ‘stippled’ effect, it means the resource is aliased indicating that 2 or more resources are sharing the same memory. In the screenshot below, the stippling effect can be seen on the command buffer.

_images/resource_overview_3.png

Allocation overview

This pane will show the allocations and all the resources in each allocation. Again, the resources will have a stippled effect if they are aliased.

_images/allocation_overview_1.png

Filtering by preferred heap is provided so that only resources in the specified preferred heaps are shown.

The coloring mode can be changed using the ‘color by .. ‘ combo box, which will color the resources and allocations by various parameters, for example, resource usage, and the preferred heap type.

The allocations can be sorted using the sort combo box at the top. Sorting is currently based on allocation size, allocation Id or resource count (the number of resources in the allocation). Another combo box to the left allows the sort to be in ascending or decending order.

Normally, allocations are sized relative to the largest allocations. Sometimes this makes smaller allocations difficult to see. The ‘Normalize allocations’ checkbox will draw all allocations the same length, as seen below:

_images/allocation_overview_2.png

The allocations can also be filtered using the search box. An allocation will only be shown if any part of its displayed text matches the text in the search 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.

Resource list

This view will show a list of all the resources in table form for all allocations.

The top of the view shows the carousel, described earlier.

The preferred heap and resource usage filter combo box can be used to show or hide resources depending on their resource type or preferred heap type. By switching all preferred heaps off, some allocations will be left. Orphaned resources are ones where the parent allocation has been deallocated without freeing the resource first. Other resources with a ‘-‘ don’t have a parent allocation.

The table items can be sorted by selecting one of the column headers. For example, if the Preferred heap column is selected, the whole table will be sorted by preferred heap.

The search box allows for resources to be filtered by any text which is present in the table. Any resources which do not match the text filter will not be displayed.

_images/resource_list_1.png

Allocation explorer

This will show the resources for each allocation. The pane consists of 2 tables. The top table lists all of the allocations. Clicking on an allocation will show it in the graphic below, along with a representation of all of the resources in the selected allocation. The coloring can be changed using the “color by ..” combo box above the graphic.

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.

_images/allocation_explorer_1.png

Resource details

This pane show the information for a selected resource. The pane is in 2 parts. The top section shows information about the selected resource and is split into a further 3 sections. To the left is a resource summary showing information about the resource (its size, which allocation it is in, when it was created etc).

The middle colum shows the resource properties which will vary depending on the resource type. For example, texture resources will show their width, height and pixel format.

The right column shows where the texture is resident in physical memory. If it is not resident, it will be shown as unmapped. From here it can be determined if the resource is resident in the heap that was requested. If not, a warning message will appear stating what the problem is.

Underneath the resource info is a timeline showing how the resource changed over time. The same data is represented in the table below. A marker is also present showing when the current snapshot was taken. Any events that happened to the resource after the snapshot are grayed out in the table. This information can be used in conjunction with the physical residency donut to determine if and why the resource memory is in a different place than requested (maybe it was made resident at some point and then paged out).

_images/resource_details_1.png

Compare windows

These panes allow the user to compare snapshots to see how allocations and resources have changed over time.

Snapshot delta

The snapshot delta gives a high level overview of the differences between two snapshots. It shows the difference in the number of allocations and resources for each heap type.

The carousel works in a similar way to the carousel in the Resource list pane but now shows the differences between the 2 snapshots, indicating such things as whether memory consumption has gone up or down.

The “Switch snapshots” button in the top right corner under the settings tab can be used to switch the snapshots.

_images/snapshot_delta_1.png

Memory leak finder

This pane shows the list of resources from both snapshots and allows them to be filtered depending on whether they are unique to one snapshot or present in both. This filtering can be achieved using the 3 checkboxes at the top. For example, just selecting the middle checkbox will show resources common to both snapshots. Underneath each checkbox is a summary of the number of resources that the checkbox represents and the total amount of memory used for that checkbox. For example, the left-most checkbox will show resources that are only present in the first snapshot.

As with the other panes, search strings and the “Filter by size” slider can be used to narrow down the list of resources.

_images/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”

Viewing resource names

The resource names will show up in the RMV UI in the resource list pane, for example:

_images/vk_resource_naming_1.png