This section contains the following chapters:
analyzer is a
utility that allows you to view and analyze the reports generated while building and
running the application. It is intended to let you review reports generated by both
the Vitis compiler when the application is
built, and the
Runtime (XRT) library
when the application is run. The Vitis
analyzer can be used to view reports from both the
v++ command line flow, and the Vitis integrated design environment (IDE). You will launch the tool
vitis_analyzer command (see Setting Up the Vitis Environment).
When first launched, the Vitis analyzer opens with a home screen that lets you open summary files, binary containers, or directories. Clicking any of these links opens a file browser that allows you to select a specific file of the type described.
- Open Summary
- Report Summaries are collections of reports related to
specific stages of application development in the Vitis tool. There are summaries created for the two steps of
the build process, compile and link, and from the run process when the
application is executed. Selecting Open
Summary lets you open one of the following:
- Compile Summary
- The Compile Summary report is generated by the
v++command during compilation, provides the status of the kernel compilation process. This collection of reports includes a Summary report, Kernel Estimate for timing and resource estimates, Kernel Guidance offering any suggestions for compilation, and the HLS Synthesis log from Vitis HLS.
- Link Summary
- The Link Summary report is created by the
v++command during linking and creation of the .xclbin file. This collection of reports includes a Summary report, System and Platform Diagrams to illustrate the hardware design, System Estimate providing timing and resources estimates, System Guidance offering any suggestions for improving linking and the performance of the system, and the Vivado Automation Summary providing design details such as interface connections, clocks, resets, and interrupts.
Tip: Timing Summary and Utilization are only generated when the build targets Hardware (as opposed to emulation).
- When you open a Link Summary, the Vitis analyzer will automatically open the associated Compile Summaries of kernels that were linked into the .xclbin file.
- Package Summary
- The Package Summary report is generated by the
v++ --packagecommand, and provides information related to the generation of emulation scripts and SD card output. When viewing the Package Summary report the tool also references the configuration file used on the command line, and the log file generated.
- Run Summary
- The Run Summary report is created by the XRT
library during the application execution, and provides a summary
of the run process. When viewing the Run Summary report the tool
also references the following reports generated during the
application run: Guidance, Profile Summary, Timeline Trace,
Platform and System Diagrams, and Simulation Waveforms when
enabled.Important: Reports generated during the runtime execution of an application generally require some prior setup as described in Profiling the Application.
When you run the application after the
v++build process, the ID from the Link Summary is assigned to the Run Summary. When you open Run Summary and Link Summary, Vitis Analyzer links them based on the shared ID.
- AI Engine Compile and Run Summaries
analyzer also lets you view reports from the Versal
AI Engine compile and run
processes. These reports are generated by the
aiesimulatoras described in the Versal ACAP AI Engine Programming Environment User Guide (UG1076).
- Open Binary Container
- Opens the selected .xclbin file to display the Platform Diagram and the System Diagram for the build.
- Open Directory
- Specifies a directory to open. The tool recursively examines the contents of the directory and displays a dialog box allowing you to select which type of files to open and which individual files to open.
vitis_analyzer command lets you
open the tool to the home screen, as discussed above, or specify a file to load when
opening the tool. You can open a file by specifying the name of the file to open.
You can open the Vitis analyzer with any of
the files supported by the tool, as described in Working with Summary Reports. For example:
You can access the command help for
vitis_analyzer command by typing the following: