amplxe-cl Actions

The amplxe-cl command tool of the Intel® VTune™ Amplifier supports different command options.

Actions

collect

Run the specified analysis type and collect data into a result.

collect-with

Run a custom hardware event-based sampling or user-mode sampling and tracing collection using your settings.

command

Issue a command to a running collect action.

finalize

Perform symbol resolution to finalize or re-resolve a result.

help

Display brief explanations of command line arguments.

import

Import one or more collection data files/directories.

report

Generate a specified type of report from an analysis result.

version

Display version information for the amplxe-cl.

Note

To access the most current command line documentation for an action, enter amplxe-cl -help <action>, where <action> is one of the available actions. To see all available actions, enter amplxe-cl -help.

Action Options

Action options define a behavior applicable to the specified action; for example, the -result-dir option specifies the result directory path for the collect action.

Note

To access the list of available action options for an action, enter amplxe-cl -help <action>, where <action> is one of the available actions. To see all available actions, enter amplxe-cl -help.

Action-Option Usage Rules:

  • If opposing action-options are used on the same command line, the last specified action-option applies.

  • An action-option that is redundant or has no meaning in the context of the specified action is ignored.

  • Attempted use of an inappropriate action-option which would lead to unexpected behavior returns a usage error.

Global Options

Global options define a behavior applicable to all actions; for example, the -quiet option suppresses non-essential messages for all actions. You may have one or more global options per command.

Note

To access the list of available global options for an action, enter amplxe-cl -help <action>, where <action> is one of the available actions. To see all available actions, enter amplxe-cl -help.

Getting Information on Analysis Options

Intel® VTune™ Amplifier offers many ways to get information on analysis options.

  • VTune Amplifier can re-use analysis configuration options set in the GUI version and command line version of such a configuration. You can copy this command line to the clipboard and use it for the command line analysis. To do this, use the Command Line... button in the Configure Analysis window. This also works for custom analysis types.

  • To get more information on an action, enter: amplxe-cl -help <action>. For example, this command returns help for the collect-with action:

    $ amplxe-cl -help collect-with

  • For information on a specific analysis type, enter: amplxe-cl -help collect <analysis_type> or amplxe-cl -help collect-with <analysis_type>. For example, this command returns help for the threading analysis type:

    $ amplxe-cl -help collect threading
  • For information on a specific report, enter: amplxe-cl -help report <report_name>. For example, this command returns help for the callstacks report:

    $ amplxe-cl -help report callstacks
For more complete information about compiler optimizations, see our Optimization Notice.
Select sticky button color: 
Orange (only for download buttons)