Using the Vitis Analyzer

The Vitis™ 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 Xilinx® 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 using the vitis_analyzer command (see Setting up the Vitis Environment).

When first launched, the Vitis analyzer opens with a home screen that lets you choose from Build and Profile reports. Clicking any of these links opens a file browser that allows you to select a specific file of the type described.

Figure 1: Vitis Analyzer – Home Screen

For the Build section:

Open Compile Summary
The Compile Summary report is generated by the v++ command during compilation, provides the status of the kernel compilation process. When viewing the Compile Summary report the tool also references the following reports generated during compilation: Kernel Estimate, Kernel Guidance, HLS Synthesis, and compilation log.
Open Link Summary
The Link Summary report is created by the v++ command during linking, provides the status of the FPGA binary build process. When viewing the Link Summary report the tool also references the following reports generated during linking: System Estimate, System Guidance, Timing Summary, Utilization, Operation Trace, Platform and System Diagrams, and linking logs. When you open a link summary, the Vitis analyzer will automatically open the associated compile summaries for kernels that were compiled with v++ command.
Note: Timing Summary and Utilization are only generated when the build targets Hardware (as opposed to emulation).
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.

For the Profile section:

Open 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 application run: Run Guidance, Profile Summary, Application Timeline, Platform and System Diagrams.
This option lets you create, select, and launch a Run Configuration and displays the command console reflecting a transcript of the run.
TIP: The Open Recent section of the home screen provides a list of recently opened summaries and reports to let you quickly reopen them.

The vitis_analyzer command allows you to 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 Reports. For example:

vitis_analyzer profile_summary.csv

You can access the command help for vitis_analyzer command by typing the following:

vitis_analyzer -help