Options - Options - 57368

-o| --output-dir <directory-path>

Predefined sampling configuration to be used to collect samples.

Use the command info --list collect-configs to get the list of supported configs. Multiple occurrences of --config are allowed.

-e | --event or <predefined-event>

A predefined event can be directly be used with -e, --event which has predefined arguments.

Alternatively, for providing more granular parameters, specify Timer, PMU, IBS event, or a predefined event with arguments in the form of comma separated key=value pairs. The supported keys are:

• event=<timer | ibs-fetch | ibs-op> or <PMU-event> or <predefined-event>
• umask=<unit-mask>
• user=<0 | 1>
• os=<0 | 1>
• cmask=<count-mask> (Value should be in the range 0x0 to 0x7f)
• inv=<0 | 1>
• interval=<sampling-interval>
• frequency=<frequency (n)> (Supported only for Core PMC events, the frequency should be provided in Hz)
• ibsop-count-control=<0 | 1> (For ibs-op event. Choose IBS OP sampling by cycle(0) count or dispatch(1) count.)
• loadstore (for ibs-op event, only on Windows platform)
• Ibsop-l3miss=<0 | 1> (Do not filter out any IBS OP samples (0), or filter out all IBS OP samples except loads/stores that miss in the L3 cache (1); supported only on AMD Zen4 and later processors.)
• ibsfetch-l3miss=<0 | 1> (Do not filter out any IBS FETCH samples (0), or filter out all IBS FETCH samples except those that miss in the L3 cache (1); supported only on AMD Zen4 and later processors.)
• call-graph

Argument details:

• user – Enable(1) or disable(0) user space samples collection
• os - Enable(1) or disable(0) kernel space samples collection
• interval – Sample collection interval. For timer, it is the time interval in milliseconds. For PMU and predefined events, it is the count of the event occurrences. For IBS FETCH, it is the fetch count. For IBS OP, it is the cycle count or the dispatch count.
• ibsop-count-control – Choose IBS OP sampling by cycle(0) count or dispatch(1) count.
• loadstore – Enable only the IBS OP load/store samples collection, other IBS OP samples are not collected.
• ibsop-l3miss – Don't filter out any IBS OP samples (0), or filter out all
• ibsfetch-l3miss – Enable IBS FETCH sample collection only when aa l3 miss occurs. For example, -e event=ibs-fetch,interval=100000,ibsfetch- l3miss

When these arguments are not passed, then the default values are:

• umask=0
• cmask=0x0
• user=1
• os=1
• inv=0
• ibsop-count-control=1 (for ibs-op event)
• ibsop-l3miss=0
• ibsfetch-l3miss=0
• interval=1.0 ms for timer event
• interval=250000 (for ibs-fetch, ibs-op, PMU-event)

Profile the existing processes by attaching to a running process. The process IDs are separated by comma.

System Wide Profile (SWP)

If this flag is not set, then the command line tool will profile only the launched application or the Process IDs attached with -p option.

Comma separated list of CPUs to profile. The ranges of CPUs can be specified with ‘-’, for example: 0-3. This option is not supported while profiling MPI applications.

Sampling interval for PMC events.

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

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

Stop the profiling when the collected data file size (in MB) crosses the specified limit.

Enable data collection at the specified frequency 'n' (in Hz) for Core PMC events.

OS Support: Windows

Enables callstack Sampling. Specify the Unwind Interval (I) in milliseconds and Unwind Depth (D) value. Specify the Scope (S) by choosing one of the following:

• user: Collect only for the user space code.
• kernel: Collect only for the kernel space code.
• all: Collect for the code executed in the user and kernel space code. Specify to collect missing frames due to Frame Pointer Omission (F) by compiler:
• fpo: If the frame pointers are not available, collect callstack information using unwind information.
• fp: Use the frame pointers to collect callstack information.

OS Support: Linux

Enables callstack sampling. Specify (F) to collect/ignore missing frames due to omission of frame pointers by compiler:

• fpo | dwarf: Collect the process callstack during sample collection and use the DWARF information to reconstruct callstack.
• fp: Use the frame pointers to collect callstack information.

When F = fpo, (N) specifies the max stack-size in bytes to collect per sample collection. Valid range of the stack size: 16 - 32768. If N is not a multiple of 8, it is aligned down to the nearest value multiple of 8. The default value is 1024 bytes.

When F = fp; the value for N is not applicable and ignored if passed.

Same as passing --call-graph fp (Linux).

Same as passing --call-graph1:128:user:fp (Windows).

Set callstack collection mode.

• fpo - If frame pointers are not available, collect call-stack information using unwind information.
• fp - Use Frame pointers to collect callstack information.

Default mode is fp.

Callstack collection mode. Default mode is fp.

• fp: Use Frame pointers to collect call stack information.
• fpo | dwarf: Collect process call stack during sample collection and use DWARF information to reconstruct the call stack.

Set callstack scope type.

Scope type should contain one of these options:

• user - Collect only for user space code.
• kernel - Collect only for kernel space code.
• all - Collect for code executed in user and kernel space.

Default scope type is user.

Set callstack unwind interval. Interval must be within the range [1 - 100]. Default interval is 1 ms.

Set callstack unwind depth. Depth must be within the range [2 - 392]. Default depth is 128.

Set callstack unwind depth. Depth must be within the range [2 - 1024]. Default depth is 32.

Callstack Size. Default size is 1024 bytes.

When mode = fpo | dwarf; size must be within [16 - 32768] and specifies the max stack- size (in bytes) to collect per call stack sample.

When mode = fp; the size is not applicable and ignored if passed.

Collect the thread run time info to report thread concurrency. Thread concurrency provides how much time specific no of threads are running simultaneously.

Size (number of pages per core) of the buffer used for data collection by the driver. The default size is 512 pages per core.

Stop the profiling when the collected data file size (in MB) crosses the specified limit. When used with the option --overwrite, the limit is before the collection is terminated. Size can be specified with the suffix Mega Bytes (M/ m), Giga Bytes (G/g), or Seconds (secs).

Specify the profile data collection mode as a ring buffer. The collection limit can be set using the option --limit-data. The default --limit-data is to restrict the raw data file size to 512 pages per core.

Profile existing threads by attaching to a running thread. The thread IDs are separated by comma.

To trace a target domain. TARGET can be one or more of the following:

• osrt - to enable tracing of os runtime. Use command info --list trace-events for the list of trace events.
• func - to enable tracing of functions. Use '--func', '--func-size' and '--func-threshold' to configure additional options.
• memory - to enable tracing of dynamic memory allocations. Use '--memory-threshold' to configure threshold.
• mpi - to enable tracing of MPI application. Use --mpi-impl and --mpi-scope to configure additional options.
• openmp - to enable tracing of OpenMP application.

  Use --openmp-impl and --openmp-scope to configure additional options.

  Note: Applicable to per process profiling. Not applicable to:

  • System wide profiling
  • Java app profiling
  • Attach process profiling
  • For ompt - application should be compiled with LLVM-8 or later, AOCC-2.1 or later, ICC-19.1 or later.
  • For omplib - application should be compiled with GCC-7 or later.
  • Supported base languages are: C, C++, and Fortran.
• gpu - To trace a target application on GPU. By default, the domain is set to hip and hsa.

Provide MPI implementation type: openmpi for tracing OpenMPI library, mpich for tracing MPICH and it's derivative libraries. Default selection is mpich.

Provide tracing scope: lwt for light-weight tracing, full for complete tracing. Default scope type is full.

Provide OpenMP implementation type: ompt for tracing of OpenMP libraries supporting OMPT interface (example: LLVM, AOCC), omplib for tracing GCC OpenMP library. Default selection is ompt.

Provide tracing scope: full for complete tracing, basic for basic tracing, where synchronization related OpenMP events are not traced to reduce the disk space usage. Default selection is basic.

Provide event names. Use command info --list trace-events for the list of trace events.

Provide event name and threshold value.

Specify functions to trace from the library or executable.

• Function-pattern can be a function name or partial name ending with '*'. Use only '*' to trace all the functions of a module.
• Module can be absolute path to library or executable.
• This option will be deprecated in a future release. Recommended to use --func.

Specify functions to trace from the library or executable.

• Function-pattern can be a function name or partial name ending with '*'. Use only '*' to trace all the functions of a module.
• Module can be absolute path to library or executable.

This option will be deprecated in a future release. Recommended is to use --exclude-func.

Provide minimum function size to trace. Default function size is 128 bytes.

This option will be deprecated in a future release. Recommended to use --func-size.

Specify functions to trace from the library or executable:

• Function-pattern can be a function name or partial name ending with '*' or only '*' to trace all the functions of a module.
• Module can be a library or executable.

Specify functions to exclude from the library or executable:

• Function-pattern can be a function name or partial name ending with '*' or only '*' to trace all the functions of a module.
• Module can be a library or executable.

Set the kernel memory mapped data buffer to size. The size can be specified in pages or with a suffix Bytes (B/b), Kilo bytes (K/k), Megabytes (M/m), and Gigabytes (G/g).

Pass this option while collecting CPU Profiling data of a MPI application. For MPI tracing, use the collect command with --trace option.

Specify the PID of qemu-kvm process to be profiled to collect guest-side performance profile.

Specify the path of guest /proc/kallsyms copied on the local host. AMD uProf reads it to get the guest kernel symbols.

Specify the path of guest /proc/modules copied to the local host. AMD uProf reads it to get the guest kernel module information.

Specify the path of guest vmlinux and kernel sources copied on the local host. AMD uProf reads it to resolve the guest kernel module information.

Capture LBR data.