Vitis Analyzer GUI and Window Manager - 2022.2 English

Vitis Unified Software Platform Documentation: Application Acceleration Development (UG1393)

Document ID
Release Date
2022.2 English

As shown below, the Vitis™ analyzer workspace is arranged into three views, which includes the Report Navigator, Reports, and the Source Code view. The different views can be opened, closed, and rearranged as needed.

Figure 1. Vitis Analyzer Workspace
Report Navigator
On the left side, this view lists all open summary files and associated reports. You can use this view to quickly find and open a report. In the figure above you can see the Link Summary is opened, and the Compile Summary is contained within it, and all their related reports are listed in the Report Navigator.

When you click any file in Report Navigator, it opens as a new tab in the Report view. Opening a file adds a green dot next to the report name in Report Navigator to let you quickly determine if a report is already open in the tool.

Tip: You can right-click the Compile Summary file to Open HLS Project, or right-click the Link Summary or Run Summary to Open Vivado Project if needed. The Vivado project cannot be opened for the Software Emulation build.
Report Window
The center area displays the contents of the summary files and open reports. You can have multiple reports open in the Reports view, and quickly change from one report to another by selecting the window tab at the top of the view.

All the reports related to the Compile Summary, Link Summary, or Run Summary are grouped together within a single container. You can arrange the reports for a container in different ways, using the New Horizontal Group, New Vertical Group, or Float commands for the reports in a container. Multiple Summary reports can be opened and the contents managed as collections.

Reports that are currently opened in Vitis analyzer will display an "out-of-date" banner if the summary files or reports have been updated on the disk, due to recompiling or rerunning the application for instance. You can keep working in the open report, or reload the updated files.

By default, some graphical reports such as the Timeline Trace are displayed in a hierarchical view, which presents the information according to the design hierarchy but consumes significant real estate in the display. As an alternative, you can select the Flatten Signal command on the toolbar to display to display the report with flattened signals and eliminate unnecessary spacing between lines. This feature is useful when there is less display area to work with, or when comparing multiple files.

You can also click the Filter command on the top right of the report window to specify the elements of the report to display. This allows you to limit the information displayed in the report window, and lets you focus on the information you are interested in for review. You can save the filters using the Save Filter As command, give each filter a meaningful name, and reuse the saved filters in other reports. This is useful when users create multiple filters, e.g. pipe stalls, memory stalls, etc. The saved filters are associated with the specific report. They cannot be accessed from other reports or summaries.

Tip: The flattened or hierarchical view of the report is saved when the report is closed, but any filters are disabled to avoid confusion as to the actual content of the reports. You can simply reapply any saved filters after reopening the reports.
Source Code
The optional Source Code view is opened on the right side of the workspace. This lets you view and edit kernel source code, based on feedback from the System Guidance report for instance. You can open the Source Code window by selecting a link in the Guidance report, or by right-clicking the Compile Summary in the Report Navigator and clicking Open Source.
Global Search
Vitis analyzer provides a search field next to the Help command in the main menu at the top of the display. You can use it to search the loaded Summary, associated reports, and source files. The search dialog box provides options to limit the scope of the search of the search terms, as shown in the following figure.
Figure 2. Global Search

The Report Navigator and Source Code views can be collapsed by clicking the Minimize button in the toolbar, and restored by clicking the tab for the collapsed view.

To close all the open source code views, select the File > Close All Sources command.

To close all the open reports associated with a Summary report, such as the Link Summary, right-click the Summary in the Report Navigator view and select Close Tabs. This closes all open reports associated with the summary in the Report view.

To close a Summary file, such as the Link Summary, right-click the file in the Report Navigator area and select Close File. Closing the Summary file closes all associated reports and files. Therefore, closing the Link Summary also ends the Compile Summary for the build.

To close all files displayed in the Report Navigator select the File > Close All Files command. This returns Vitis analyzer to the home screen.