Working with Reports
Generally, the Summary reports provide you a great overview of the specific steps in building and profiling the application to get a good view of where the application is with regard to performance and optimization. For individual kernels review the Compile Summary. For the device binary (xclbin), start with the Link Summary, which also loads the Compile Summaries for linked kernels. For embedded processor and Versal™ AI Engine systems review the Package Summary. For profiling data related to the application execution start with the Run Summary.
In addition, the File menu offers commands to let you open individual reports, and directories of reports.
- 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.
- Open Binary Container
- FPGA binary, <name>.xclbin, created by the compilation and linking process as described in Building and Running the Application.
- Open Report
- Opens one of the report files generated by the Vitis™
core development kit during compilation, linking, or running the application.
The reports you can open include:
- Application Timeline
- Refer to Timeline Trace.
- Profile Summary
- Refer to Profile Summary Report.
- Waveform
- Waveform database and waveform config file as described in Waveform View and Live Waveform Viewer.
- Utilization
- A resource utilization report generated by the Vivado® tool when you build the system hardware (HW) target.
The Vitis analyzer can also open Kernel Estimate, Operation Trace, AI Engine Trace, Timeline Trace, System Estimate, Log, and Timing Summary reports. Refer to Profiling the Application for more information on the individual reports generated by the build and run processes.
The Vitis analyzer displays log files rendered for improved readability. Some key additions the tool provides when viewing log files include line wrapping, message severity tagging (Error, Warning, Info), added hyperlinks to referenced files, search capability, and live log monitoring. This last feature lets you open a log file in-process and see it rendered in real time.
Viewing Report Contents
The features of the Vitis analyzer depend on the specific report you are viewing. When the report is structured like a spreadsheet you interact with the report like a spreadsheet, selecting rows or cells of data, and sorting columns by clicking on the column header. When the report is graphical in nature, you can interact with the report by zooming into the report to view details, and zooming out to view more information. The Vitis analyzer supports the following mouse strokes to let you quickly zoom into and out of a graphical report:
- Zoom In
- Press and hold the left mouse button while dragging the mouse from top left to bottom right to define an area to zoom into.
- Zoom Out
- Press and hold the left mouse button while drawing a diagonal line from lower left to upper right. This zooms out the window by a variable amount. The length of the line drawn determines the zoom factor applied. Alternatively, press Ctrl and scroll the wheel mouse button down to zoom out.
- Zoom Fit
- Press and hold the left mouse button while drawing a diagonal line from lower right to upper left. The window zooms out to display the entire device.
- Horizontal scrolling
- In a report such as the Application Timeline, you can hold the shift button down while scrolling the middle mouse roller to scroll across the timeline.
- Panning
- Press and hold the wheel mouse button while dragging to pan.
Configuring the Vitis Analyzer
The command opens the Vitis Analyzer Settings dialog box as shown below.
In the General settings, the following can be configured:
- Default Directory
- Specifies the default directory used by the Vitis™ analyzer when it is opened.
- Recent
- Configures the tool to restore the workspace when reopening the Vitis analyzer, and specify the number of entries to display for commands.
- Report Tabs
- Defines the number of reports and views that can be opened in the main Reports window.
- Scaling
- Sets the font scaling to make the display easier to read on high resolution monitors. Use OS font scaling uses the value set by the OS for your primary monitor. User-defined scaling allows you to specify a value specific to the Vitis analyzer.
- Spacing
- Sets the amount of space used by the Vitis IDE. Comfortable is the default setting. Compact reduces the amount of space between elements to fit more elements into a smaller space.
- Compile Summary
- Select which reports are listed in the Report Navigator view, and opened with the Compile Summary.
- Link Summary
- Select which reports are listed and opened with the Link Summary.
- Run Summary
- Select which reports are listed and opened with the Run Summary. Also, select which reports are dynamically updated while the application is running. Both the Application Timeline and Timeline Trace reports can be automatically reloaded when continuous trace data is captured as described in Continuous Trace Capture. This lets you observe the trace data in Vitis analyzer as it is captured from your running application.
- Binary Container
- Select which reports are listed and opened with the Binary Container.
- AI Engine Compile Summary
- Select which reports are listed and opened with the AI Engine Compile Summary.
- AI Engine Run Summary
- Select which reports are listed and opened with the AI Engine Run Summary.
For Window Behavior settings, the following can be configured:
- Warnings
- Shows warning when exiting or just exits the Vitis analyzer.
- Alerts
- Issues an alert when you are running the tool on an unsupported operating system.
After configuring the tool, click OK, Apply, or Cancel. You can also use the Restore command to restore the defaults settings of the tool.
Layout
The Vitis analyzer also lets you arrange reports in different layouts, and save those layouts for reuse. This allows you to arrange two reports for comparison, or to check one report against the other. The Layout menu in the main menu lets you switch between existing layouts, or save a custom report layout using the Save Layout As command. You can also Reset Layout to return it to its saved configuration, or Remove Layout to eliminate saved layout.