Data Collection Using CLI - Data Collection Using CLI - 57368

uProf User Guide

Document_ID
57368
Release_Date
2025-06-09
Revision
5.1 English
  • Hotspots collection
    AMDuProfCLI collect --config hotspots -o <output-dir> <application>
  • Hotspots with callstack collection
    AMDuProfCLI collect --config hotspots -g -o <output-dir> <application>
  • Hotspots with timer interval of 100msec
    AMDuProfCLI collect --config hotspots --timer-interval 100 -o <output-dir> <application>
  • Hotspots with profiling signal as SIGRTMIN
    AMDuProfCLI collect --config hotspots --profiling-signal 34 -o <output-dir> <application>
  • Hotspots with callstack collection for GCC compiled OpenMP application
    AMDuProfCLI collect --config hotspots -g --openmp-impl omplib -o <output-dir> <application>
  • Hotspots with callstack collection and unwind depth as 128
    AMDuProfCLI collect --config hotspots -g --call-graph-depth 128 -o <output-dir> <application>

Once profile data collection completes, session directory will be generated. Use session directory to generate the csv report (or) to import the session in GUI.

Refer Table 1 for all supported options.

Example

[amd@uprof-ethanolx5 bin]$ ./AMDuProfCLI collect --config hotspots -g -o /tmp/ /tmp/ScimarkStable
Profiling started
………
Profiling (data collection) completed
Generated data files path: /tmp/AMDuProf-ScimarkStable-Hotspots_Sep-05-2024_21-43-08.

Here, the generated session directory is /tmp/AMDuProf-ScimarkStable-Hotspots_Sep-05-2024_21-43-08.

Options

Table 1. Hotspots Analysis options
CLI option GUI option Description
--timer-interval <interval> Predefined Configs > Hotspots > Timer Interval Provide per thread OS timer interval in msec. Default timer interval is 10 ms.
--profiling-signal <signal> Predefined Configs > Hotspots > Profiling Signal If application has signal handler for SIGPROF, then use this option to provide unused signal from SIGRTMIN to SIGRTMAX.

It is valid only in Linux for launch application.

--openmp-impl <impl> Predefined Configs > Hotspots > Advanced Options > Select OpenMP Implementation Provide the OpenMP implementation type to stitch the call path of worker threads with master thread. ompt for tracing of OpenMP libraries supporting OMPT interface (example: LLVM, AOCC), omplib for tracing GCC OpenMP library. ompt is the default selection.

It is valid only in Linux for launch application.

--call-graph-depth <depth> Predefined Configs > Hotspots > Advanced Options > Call Stack Unwind Depth Provide the depth of stack frames to be collected. By default, 32 frames will be collected; if the application has a greater number of frames in a calling sequence, increase the unwind depth up to 1024.