manage_ipcache Utility - 2023.2 English

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

Document ID
Release Date
2023.2 English

To provide better performance during synthesis of kernels in your application designs, the AMD Vitis™ compiler uses an IP cache to store and reuse synthesis results. This lets the build process for the .xclbin file avoid having to repeat synthesis for kernels and CUs that have not changed. The IP cache stores the synthesis results and applies them for unchanged kernels in the design.

By default, the IP cache is stored inside the Vitis IDE workspace for a project, or at the level of your builds when running v++ from the command line. You can customize the location for the IP cache using --remote_ip_cache to specify a new location, or disable the use of the IP cache using --no_ip_cache. See v++ General Options for information on these options.

The manage_ipcache utility is a standalone utility to help you manage the contents of your IP cache repository. It lets you report statistics on the IP cache repository and remove entries based on a variety of criteria.

Table 1. manage_ipcache Options
Option Description
-c | --cache Required. Specifies the IP Cache directory to work on.
-d | --disk_space <size> Delete all but the most recently used entries that fit in the disk space specified in MB.
-h | --help Prints help for the manage_ipcache command.
-k | --keep_top <N> Delete all but the top N most recently used entries (N is an integer).
-o | --outfile <file> Report stats for the IP cache to the specified file.
-p | --purge Delete ALL cache entries.
-r | --report Report stats for the IP cache to stdout.
-u | --unused Delete cache entries that have never been used (no cache hits).
The following example reports on the entries of the specified IP cache:
manage_ipcache --cache ./ip_cache --report

The manage_ipcache command returns 0 if successful, or returns -1 if an error occurs.