Options - Options - 57368

uProf User Guide
Document ID
57368
Release Date
2025-06-09
Revision
5.1 English

Following table lists the diff commands:

Table 1. Example table
Option Description
-h| --help Displays this help information on the console/terminal.

--baseline <directory-path>

Path to the directory containing collected data. The profile data in this directory will be treated as the base profile against which all other profiles will be compared.
--with <directory-path> Path to the directory containing collected data. Each profile specified with -- with will be considered as a non-base profile and compared against the base profile. You can use multiple instances of --with to specify multiple non-base profiles for comparison.

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

Path to the directory containing collected data. Multiple occurrences of -i is allowed. First occurrence of -i is considered as the base session, while all the subsequent occurrences of -i are treated as non-base sessions.

Note: When using -i, --input-dir, you should not use the --baseline or --with options in conjunction. If you use --baseline and -i together, the --baseline option will take precedence and be considered as the base session. If the --baseline option is not present, the first occurrence of -i will automatically be considered as the base session.

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

Path where the markdown comparison report will be generated.
--type <comparison- type>

Specify the type of comparison to be performed. The supported comparison types are:

  • name: With this type, only the top ‘n’ functions from the base profile will be compared with the corresponding functions available in the non-base profiles. The comparison will focus on the similar functions between the profiles.
  • order: With this type, the top ‘n’ functions from all the profiles will be displayed in the order of profiles. The order will be: base profile first, followed by the first non-base profile, second non-base profile, and so on. The comparison will still be performed with the functions present in the base profile and only for the similar functions across the profiles.

The default comparison type is name.
--html Use this option to create comparison report in HTML format. If not specified, the default comparison report format Markdown will be  used to generate the report.
--alias <base- fun,non-base- fun,…|base-fun-1,non-base-fun- 1,…|…>

In the cases where the function names have changed in the non-base profile, specify the function names in the non-base profile that should be compared with the corresponding function names in the base profile.

Specify different functions using the pipe symbol '|'as a separator. For each set of functions, you can use a comma to separate the function names between the base profile and the non-base profile.
--show-percentage Comparison results will be displayed in terms of percentages.
--cutoff <n> Cut-off to limit the number of functions to be reported. ‘n’ is the maximum number of entries to be reported in various report sections. The default value is 10.

--sort-by| -s <EVENT>

Specify the Timer, PMC, or IBS event on which the reported profile data will be sorted with arguments in the form of comma separated key=value pairs. The supported keys are:

  • event=<timer | ibs-fetch | ibs-op | pmcxNNN>, where NNN is hexadecimal Core PMC event ID.
  • umask=<unit-mask>
  • user=<0 | 1>
  • os=<0 | 1>

Use the command info --list pmu-events for the list of supported PMC events. The arguments details:

  • umask — Unit mask in decimal or hexadecimal. Applicable only to the PMC events.
  • user, os — User and OS mode. Applicable only to the PMC events.

Multiple occurrences of –sort-by(-s)are not allowed.
--view <view-config>

Compare only the events present in the given view file. Use the command

info --list view-configsto get the list of supported view-configs.
--stdout Comparison report will also be displayed in the terminal or command line interface apart from saving to a file.

--src-path <path1;...>

Source file directories (semicolon separated paths) for base profile. This will be considered for the non-base profiles if the corresponding file directories are not specified separately.

Multiple use of --src-path is allowed.

--bin-path <path1;...>

Binary file path for the base profile. This will be considered for the non-base profiles if the corresponding bin path is not specified separately.

Multiple usage of --bin-path is allowed.

--src-path1 <path1;...>

Source file directories (semicolon separated paths) for the first non-base profile. Multiple use of --src-path1 is allowed.

--bin-path1 <path1;...>

Binary file path for the first non-base profile. Multiple usage of --bin-path1 is allowed.

--src-path2 <path1;...>

Source file directories (semicolon separated paths) for the second non-base profile. Multiple use of --src-path2 is allowed.

--bin-path2 <path1;...>

Binary file path for the second non-base profile. Multiple usage of --bin-path2 is allowed.

--src-path3 <path1;...>

Source file directories (semicolon separated paths) for the third non-base profile. Multiple use of --src-path3 is allowed.

--bin-path3 <path1;...>

Binary file path for the third non-base profile. Multiple usage of --bin-path3 is allowed.