Opening the Run Summary with Vitis Analyzer - 2024.1 English

Vitis Tutorials: Getting Started

Document ID
Release Date
2024.1 English

The Vitis unified IDE will read a workspace or folder and determine all of the report summary files contained within the folder. You can use the following commands to open the folder and import the various summary files:

vitis -a ./hw_emu
vitis_analyzer ./hw_emu

NOTE: The vitis_analyzer command has been updated to open the Analysis view of the Vitis Unified IDE, and loads the run summary as described in Working with the Analysis View.

The tool examines the specific folder or workspace, and determines the summary reports to display in the Analysis view. It displays a list of the found reports and lets you choose which reports to open, as shown in the following figure.

Open Summary

Click Open to open the reports in the Analysis view of the IDE. The reports are displayed as shown in the following figure.

Open Summary

Click the Summary report of the Link Summary.

  • The Link Summary shows the v++ --link command and provides a System Estimate of performance.

  • Notice the Estimated Resources information displayed next to the vadd kernel.

  • The Guidance report flags issues and potential issues in your application and kernel, and provides actionable feedback on how to improve it.

  • This simple example is not fully optimized and Guidance reports several warnings. Inspect each of these warnings to learn more about optimization opportunities and design best practices.

  • What can you learn about the width of the kernel ports?

The link_summary also includes the compile_summary. Take a look at the various elements of the compile_summary report by selecting them in the Vitis Analyzer tool.

Now, open the Run Summary.

  • Open the Profile Summary report.

    • The Profile Summary provides annotated details regarding the overall application performance. All data generated during the execution of the application is grouped into categories.

    • Use the left pane of the report to navigate through the various categories, and explore all the metrics reported in the Profile Summary.

  • Open the Timeline Trace.

    • The Timeline Trace collects displays host and kernel events on a common timeline to help visualize the overall health and performance of your system. The graphical representation is very useful to see issues regarding kernel synchronization and efficient concurrent execution.

    • Zoom in and scroll to the far right of the timeline trace to visualize the point where the host program transfers the buffers and executes of the kernel.

    • Hover over the various activity events to get more details about each of them.

    • Can you relate the timeline activity to the sequence of API calls in the host.cpp file?


When you are done exploring the various reports in Vitis Analyzer, you can close the tool.