Vtune

Introduction

VTune is Intel's Performance Analysis tool for applications and systems. It is capable of Analyzing both OpenMP and MPI based applications.

Software module

To load the module on any Compute Canada cluster run:

[name@server ~]$ module load vtune

Tool renaming

The content of this page is largely concerned with the legacy version named Intel® VTune™ Amplifier. Please note this tool has been renamed throughout Intel's documentation in latest versions (newer than the latest vtune module versions presently available on Compute Canada clusters) from Intel® VTune™ Amplifier to Intel® VTune™ Profiler. Likewise the application commands amplxe-cl and amplxe-gui have been renamed to vtune and vtune-gui for both the command line and graphical tools respectively. Once a version with the newer naming convention is available as a loadable module in the forthcoming default StdEnv/2020 environment this Wiki page will be updated accordingly. Further information can be found here.

Analysis types

To collect analysis information run:

[name@server ~]$ amplxe-cl -collect <analysis-type> <target_exe> <exe_arguments>

where <analysis-type> should be replaced by one of the available analysis, e.g. hotspots, and <target_exe> is the path to the executable you would like to analyze. It is recommended to compile your executable with the "-g" option and to use the same optimization level as normal so as to obtain accurate results. A listing of version specific argument options and several usage examples maybe displayed on the command line by running amplxe-cl -help, after loading the vtune module. Complete downloadable documentation for Parallel Studio XE (including VTune) for all recent versions can be found here. The latest version of the Intel VTune Profiler User Guide may be found here.

Create reports

To create a report run this command:

[name@server ~]$ amplxe-cl -report <report-type>

where <report-type> is the type of the report to generate, e.g. hotspots. See also:

• https://software.intel.com/en-us/vtune-amplifier-help-generating-command-line-reports

Matrix example

Analyze and generate a summary report for the Intel Matrix Sample Project run from the command line with 4 cores:

salloc --time=1:00:00 --cpus-per-task=4 --ntasks=1 --mem=16G --account=def-yours
module load StdEnv/2016.4 *OR* StdEnv/2018.3
module load intel/2019.3 (optional)
module load vtune/2019.3
cp -a $EBROOTVTUNE/vtune_amplifier/samples/en/C++/matrix .
cd matrix/linux
make icc
amplxe-cl -collect hotspots ../matrix
amplxe-cl -report summary 

The latest version of matrix_multiply (uses cmake to build) can be found here.

Graphical mode

The Intel Matrix Sample Project an also be run using Vtune in GUI mode as explored here [1]. To run VTune over VNC follow the below directions depending on which system you wish to use. Running VTune graphically can be useful to generate command line configurations as discussed in [2].

Cluster nodes

1. Connect to a cluster compute or login node with TigerVNC
2. module load StdEnv/2016.4 *OR* StdEnv/2018.3
3. module load intel/2019.3 (optional)
4. module load vtune/2019.3
5. amplxe-gui
   

VDI nodes

1. Connect to gra-vdi.computecanada.ca with TigerVNC
2. module load CcEnv StdEnv/2016.4 *OR* StdEnv/2018.3
3. module load intel/2019.3 (optional)
4. module load vtune/2019.3
5. amplxe-gui
   

MPI example

First, load the latest VTune module.

module load StdEnv/2020
module load vtune

Then compile your MPI program as you usually would and run it inside a job or in an interactive session started by a salloc command using:

srun aps your_mpi_program.x

After the program finishes, the profiling data will be stored in a directory called aps_result_YYYYMMDD where YYYYMMDD is the current date.

There is a lot of information you can extract from that data. To get the basic summary report of your program's performance, run:

aps-report  -D aps_result_YYYYMMDD

where you would replace YYYYMMDD to match the actual directory that has been created. This command creates an HTML file, which can be copied to your own computer and viewed in a browser. The report will clearly identify performance issues that are affecting your code.

Example report generated by aps for an MPI program

Message Passing Interface