Options - Options - 57368

uProf User Guide

Document_ID
57368
Release_Date
2025-06-09
Revision
5.1 English

Following table lists the AMDuProfCLI translate command options

Table 1. AMDuProfCLI Translate Command Options
Option Description
-h| --help Displays the help information.

-i| --input-dir <directory-path>

Path to the directory containing collected data.

--time-filter <T1:T2>

Restricts the processing to the time interval between T1 and T2, where T1, T2 are time in seconds from profile start time.
--agg-interval <low | medium | high | INTERVAL>

Use this option to configure the sample aggregation interval which is useful when the session is imported to GUI.

low level of aggregation interval generates better timeline view in GUI but increases the database size.

Aggregation INTERVAL can also be specified as a numeric value in milliseconds.

--bin-path <path> Binary file path. Multiple use of --bin-path is allowed.

--symbol-path <path>

Debug symbol path. Multiple instances of --symbol-path are allowed.
--inline

Inline function extraction for C and C++ executables.

Note:
  1. This option is not supported on Windows.
  2. Using this option will increase the time taken to generate the report.
--retranslate Re-translate the collected data files with a different set of translation options.
--log-path <path-to-log-dir>

Specify the path where the log file should be created. If this option is not provided, the log file will be created either in the path set by AMDUPROF_LOGDIR environment variable or %TEMP% path by default.

The log file name will be of the format $USER-AMDuProfCLI.log (on Linux, FreeBSD) or %USERNAME%-AMDuProfCLI.log (on Windows).

--enable-log Enable additional logging with log file.
--enable-logts

Capture the timestamp of the log records. This option should be used with the--enable-log option.

--remove-raw-files Remove the raw data files to recover the disk space.
--python-show-all Use this option to show Python interpreter functions in the callgraph/flamegraph when translation is performed on Python profiled data (on Linux).
--export-session Create a compressed archive of required session files which can be used in other system for analysis.
--symbol-server <path1;…> OS Support: Windows

Links to Symbol Server. For example: Microsoft Symbol Server. Multiple instances of --symbol-server are allowed.

--symbol-cache-dir <path> OS Support: Windows

Path to save the symbols downloaded from the Symbol Servers.

--legacy-symbol- downloader OS Support: Windows

Download symbols using the Microsoft Symsrv. By default, AMD symbol downloader will be used.

--category <PROFILE> OS Support: Linux
Process only a specific profiling category. Comma separated multiple categories can be specified. If this option not used, then all categories raw data files are processed. Multiple instances of --category are allowed. The supported categories are:
  • cpu - CPU Profiling
  • mpi - MPI Tracing
  • openmp – Generate report specific to OpenMP Tracing.
  • trace - User mode tracing
  • gputrace - GPU Tracing
  • gpuprof - GPU Profiling

Example:

category cpu, mpi, trace, gputrace, gpuprof

--category mpi --category cpu --category trace --category gputrace --category gpuprof

--host <hostname> OS Support: Linux
This option is used with the --input-dir option. It processes samples belonging to a specific host. The supported options are:
  • <hostname>: Translate only the processes belonging to a specific host.
  • all: Translate all processes.
Note: If --host is not used, then only the processes belonging to the current system is translated. In case the system is a master node in a cluster, then processing will be done for the lexicographically first host in that cluster.
--kallsyms-path <path> OS Support: Linux

Path to the file containing kallsyms info. If no path is provided, it defaults to / proc/ kallsyms.

--vmlinux-path <path> OS Support: Linux

Path to the Linux kernel debug info file. If no path provided, it searches for the debug info file in the default download path.