Add files via upload

Add documentation for RMV 1.0

Author: ahosier

docs/source/_static/theme_overrides.css

@@ -0,0 +1,13 @@
+
+
+img {
+  max-width: 100%;
+  max-height: auto;
+  box-shadow: 6px 6px #eee;
+  -ms-interpolation-mode: bicubic;
+  border: 1px solid #ccc;
+}
+
+table {
+	font-size: 12px;
+}

docs/source/allocation_explorer.rst

@@ -0,0 +1,15 @@
+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.
+
+.. image:: media/snapshot/allocation_explorer_1.png

docs/source/allocation_overview.rst

@@ -0,0 +1,32 @@
+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.
+
+.. image:: media/snapshot/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:
+
+.. image:: media/snapshot/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**.

docs/source/capture.rst

@@ -0,0 +1,8 @@
+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.

docs/source/carousel.rst

@@ -0,0 +1,41 @@
+The Carousel
+------------
+
+The carousel is displayed on the **Resource list** panes and displays high level
+information about the resources in the current snapshot. It can be seen as an
+overview to answer high level questions such as 'How much memory in each heap
+is my application using?' or 'How large are my allocations?'.
+
+The **Allocation sizes** shows the sizes of allocations arranged in buckets.
+It is easy to see at a glance how many allocations are being used and their
+relative sizes.
+
+.. image:: media/snapshot/carousel_allocation_sizes.png
+
+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.
+
+.. image:: media/snapshot/carousel_committed_memory.png
+
+The **Requested virtual memory** shows which memory was requested from which heap.
+The same coloring scheme is used as in the **Heap overview** pane so it is easy to
+see if certain heaps are over or undersubscribed.
+
+.. image:: media/snapshot/carousel_requested_virtual_memory.png
+
+The **Resource types** shows the makeup of the resources contained within the
+allocations. The most popular ones are displayed with everything else bucketed
+in the "Other" category.
+
+.. image:: media/snapshot/carousel_resource_types.png
+
+The **Virtual memory** shows how much memory has resources bound to it. Unbound
+memory is effectively usused so should be minimized as much as possible. Sometimes
+due to alignment issues this is not possible but if there is a lot of unbound
+memory, this will be seen in the *Allocation overview* pane for each allocation.
+
+.. image:: media/snapshot/carousel_virtual_memory.png
+
+The carousel is also shown in the **Snapshot delta** pane but here it shows the
+differences between the 2 selected snapshots.

docs/source/conf.py

@@ -0,0 +1,197 @@
+# -*- coding: utf-8 -*-
+#
+# Radeon Memory Visualizer documentation build configuration file, created by
+# sphinx-quickstart on Fri Jun 30 12:01:48 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Radeon Memory Visualizer'
+copyright = u'2018-2020, 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.0.0'
+# The full version, including alpha/beta/rc tags.
+release = u'1.0.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+#html_theme = 'alabaster'
+#html_theme = 'classic'
+#html_theme = 'sphinxdoc'
+#html_theme = 'scrolls'
+#html_theme = 'agogo'
+#html_theme = 'traditional'
+#html_theme = 'nature'
+#html_theme = 'haiku'
+#html_theme = 'pyramid'
+#html_theme = 'bizstyle'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {'stickysidebar': 'true'}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If a function setup(app) exists, Sphinx will call this function as a normal
+# extension during application startup. This method of using the overrides css
+# file works better with read the docs (more so than specifying it via the
+# html_context tag)
+def setup(app):
+    app.add_stylesheet('theme_overrides.css')
+
+html_show_sourcelink = False
+html_show_sphinx = False
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'RadeonMemoryVisualizerdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'RadeonMemoryVisualizer.tex', u'Radeon Memory Visualizer Documentation',
+     u'AMD Developer Tools', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'radeonmemoryvisualizer', u'Radeon Memory Visualizer Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'RadeonMemoryVisualizer', u'Radeon Memory Visualizer Documentation',
+     author, 'RadeonMemoryVisualizer', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+epub_author = author
+epub_publisher = author
+epub_copyright = copyright
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+

docs/source/heap_overview.rst

@@ -0,0 +1,37 @@
+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.
+
+.. image:: media/snapshot/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).