Running Analysis from the Command Line

You can use either the collect or collect-with actions to perform analysis. These actions are similar, but the collect-with action provides some additional support for customization.

The analysis process includes data collection, finalization, creation of a result, and the generation of a Summary report. The terms analysis and collection are synonyms for these processes.

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 automatically generate a 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 Analysis Type window. This also works for custom analysis types.

• To get more information on the collect or collect-with actions, 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>. For example, this command returns help for the locksandwaits analysis type:

  $ amplxe-cl -help collect locksandwaits

• For information on a knob, enter:

  $ amplxe-cl -knob-list <analysis_type>

Running an Analysis

• Choose one of the analysis types or collectors listed in the -help collect.

• Some analysis types and collectors support knobs (configuration options) that provide additional settings.

• There are many other options you can use to configure an analysis. For example, you can specify which process or components should be analyzed, whether collection begins immediately or after a pause.

To run a performance analysis from the command line, use the amplxe-cl command as follows:

amplxe-cl -collect <analysis_type> [--] <target>

where

• <analysis_type> is the type of analysis to run. To see the list of available analysis types, enter:

  amplxe-cl -help collect

• <target> is the path and name of the application to analyze.

Outcome: VTune Amplifier collects the specified type of data.

Next steps: After collecting performance results for your target, you can view the result in the GUI or use the report action to generate a report.

Running Analysis Remotely from the Command Line

For remote analysis, make sure to use the -target-system option to specify one of the following types of the remote target systems:

• remote Linux* system

• Android* device (supported with VTune Amplifier for Systems only)

• Intel® Xeon Phi™ coprocessor for native applications and host applications (offload, mpirun, OpenCL™ programs) submitting work to the card (supported with VTune Amplifier XE only)

Example

Run a Hotspots analysis on myApplication:

$ amplxe-cl -collect hotspots -- home/test/myApplication

This example of the collect-with action shows how knobs are used. Run a custom hardware event-based sampling collection for the sample application with the specified events.

$ amplxe-cl -collect-with runsa -knob event-config=CPU_CLK_UNHALTED.CORE,CPU_CLK_UNHALTED.REF,INST_RETIRED.ANY home/test/sample

Run the Advanced Hotspots analysis for a native application on the Intel Xeon Phi coprocessor:

$ amplxe-cl --collect advanced-hotspots --knob collection-detail=stack-sampling --target-system=mic-native -r matrix_r001 --search-dir /opt/mpss/3.2.1/sysroots/k1om-mpss-linux/boot