Difference between revisions of "Development/Intel Compiler"

From bwHPC Wiki
Jump to: navigation, search
m (Further literature)
Line 19: Line 19:
 
|-
 
|-
 
| Included modules
 
| Included modules
| icc | icpc | ifort | idb
+
| icc | icpc | ifort | idb | gdb-ia
 
|}
 
|}
 
<br>
 
<br>
 
= Introduction =
 
= Introduction =
 
The '''Intel Compiler''' of the '''Intel Composer XE Suite''' consists of tools to compile and debug C, C++ and Fortran programs:
 
The '''Intel Compiler''' of the '''Intel Composer XE Suite''' consists of tools to compile and debug C, C++ and Fortran programs:
{| width=400px class="wikitable"
+
{| width=500px class="wikitable"
 
|-
 
|-
 
|style="padding:3px"| icc
 
|style="padding:3px"| icc
Line 36: Line 36:
 
|-
 
|-
 
|style="padding:3px"| [[#GUI|idb]]
 
|style="padding:3px"| [[#GUI|idb]]
|style="padding:3px"| Intel debugger in GUI mode
+
|style="padding:3px"| Intel debugger in GUI mode (until version 14 only)
  +
|-
  +
|style="padding:3px"| [[#Console Mode|gdb-ia]]
  +
|style="padding:3px"| Intel version of GNU debugger in console mode (from version 15)
 
|-
 
|-
 
|style="padding:3px"| [[#Console Mode|idbc]]
 
|style="padding:3px"| [[#Console Mode|idbc]]
|style="padding:3px"| Intel debugger in console mode
+
|style="padding:3px"| Intel debugger in console mode (until version 14 only)
 
|}
 
|}
Aside from that the suite also includes the TBB (Threading Building Blocks) and IPP (Integrated Performance Primitives) libraries.
+
The intel compiler suite also includes the TBB (Threading Building Blocks) and IPP (Integrated Performance Primitives) libraries.
 
<br>
 
<br>
 
<br>
 
<br>
Line 48: Line 51:
   
 
= Versions and Availability =
 
= Versions and Availability =
A list of versions currently available on all bwHPC-C5-Clusters can be obtained from the
+
A list of versions currently available on all [[:Category:BwHPC Cluster|bwHPC Clusters]] can be obtained from the cluster information system
 
<br>
 
<br>
  +
[https://cis-hpc.uni-konstanz.de/prod.cis/ Cluster Information System]
<big>
 
  +
<!--
 
[https://cis-hpc.uni-konstanz.de/prod.cis/ Cluster Information System CIS]
 
 
</big>
 
 
{{#widget:Iframe
 
{{#widget:Iframe
 
|url=https://cis-hpc.uni-konstanz.de/prod.cis/bwUniCluster/compiler/intel
 
|url=https://cis-hpc.uni-konstanz.de/prod.cis/bwUniCluster/compiler/intel
Line 60: Line 60:
 
|height=700
 
|height=700
 
}}
 
}}
  +
!-->
  +
 
On the command line interface of any bwHPC cluster you'll get a list of available versions
 
On the command line interface of any bwHPC cluster you'll get a list of available versions
  +
by executing:
by using the command 'module avail compiler/intel'.
 
 
<pre>
 
<pre>
$ : bwUniCluster
 
 
$ module avail compiler/intel
 
$ module avail compiler/intel
---------------------- /opt/bwhpc/common/modulefiles -----------------------
 
compiler/intel/12.1 compiler/intel/14.0
 
compiler/intel/13.1 compiler/intel/15.0(default)
 
 
</pre>
 
</pre>
  +
<br>
 
<br>
 
<br>
 
== Loading the module ==
 
== Loading the module ==
 
=== Default Version ===
 
=== Default Version ===
 
You can load the default version of the Intel Compiler with the command
 
You can load the default version of the Intel Compiler with the command
''''module load compiler/intel''''.
 
 
<pre>
 
<pre>
$ module avail compiler/intel
 
---------------------- /opt/bwhpc/common/modulefiles -----------------------
 
compiler/intel/12.1 compiler/intel/14.0
 
compiler/intel/13.1 compiler/intel/15.0(default)
 
 
$ module load compiler/intel
 
$ module load compiler/intel
$ module list
 
Currently Loaded Modulefiles:
 
1) compiler/intel/15.0(default)
 
 
</pre>
 
</pre>
Here, we got the "default" version 15.0 (example).
 
 
<br>
 
<br>
The module will try to load modules it needs to function.
 
 
If loading the module fails, check if you have already loaded the module
 
If loading the module fails, check if you have already loaded the module
 
with 'module list'.
 
with 'module list'.
Line 92: Line 81:
   
 
=== Specific (newer or older) Version ===
 
=== Specific (newer or older) Version ===
If you wish to load a specific (older or newer) version (if available), you can do so using e.g.
+
If you wish to load a specific (older or newer) version (if available),
  +
add the specific version number of the intel compiler, e.g. for loading Intel compiler suite 14.0, execute:
''''module load compiler/intel'''/version' to load the version you desires.
 
 
<pre>
 
<pre>
$ module avail compiler/intel
+
$ module unload compiler/intel
  +
$ module load compiler/intel/14.0
---------------------- /opt/bwhpc/common/modulefiles -----------------------
 
compiler/intel/12.1 compiler/intel/14.0
 
compiler/intel/13.1 compiler/intel/15.0(default)
 
$ module load compiler/intel/14.0
 
$ module list
 
Currently Loaded Modulefiles:
 
1) compiler/intel/14.0
 
 
</pre>
 
</pre>
  +
Note: Only one compiler can be loaded in your active session, hence, before loading a new intel compiler version you must to unload the current loaded version.
Intel C-Compiler "version 14.0" is loaded now (example).
 
<br>
 
<br>
 
   
  +
For unloading the intel compiler the version number is not required:
= Intel C-Compiler-Specific Environments =
 
  +
<pre>
To see a list of all Intel C-Compiler environments set by the 'module load'-command use the command '''module show compiler/intel'''.
 
  +
$ module unload compiler/intel
<br>
 
  +
</pre>
Example (excerpt, default version)
 
  +
unloads any currently loaded intel compiler version.
  +
  +
  +
= Intel Compiler Specific Environment Variables =
  +
To see a list of all Intel Compiler environment variables set by the 'module load' command execute:
 
<pre>
 
<pre>
$ module show compiler/intel # output is revised
+
module show compiler/intel
-------------------------------------------------------------------
 
/opt/bwhpc/common/modulefiles/compiler/intel/15.0:
 
[...]
 
INTEL_VERSION = 15.0.3
 
INTEL_HOME = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187
 
INTEL_BIN_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/bin/intel64
 
INTEL_LIB_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/compiler/lib/intel64
 
INTEL_LIB_MIC = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/compiler/lib/mic
 
INTEL_LIB_MICMPI = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/mpirt/lib/mic
 
INTEL_INC_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/compiler/include
 
INTEL_MAN_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/man/en_US
 
INTEL_DOC_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/Documentation/en_US
 
GDB_VERSION = 15.0.3
 
GDB_HOME = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/debugger/gdb/intel64
 
GDB_BIN_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/debugger/gdb/intel64/bin
 
GDB_LIB_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/debugger/libipt/intel64/lib
 
GDB_INC_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/debugger/gdb/intel64/include
 
GDB_INF_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/debugger/gdb/intel64/share/info
 
GDB_MAN_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/debugger/gdb/intel64/share/man
 
ICC_VERSION = 15.0.3
 
ICC_HOME = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187
 
ICC_BIN_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/bin/intel64
 
ICC_LIB_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/compiler/lib/intel64
 
ICC_INC_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/compiler/include
 
ICC_MAN_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/man/en_US
 
ICC_DOC_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/Documentation/en_US
 
IFORT_VERSION = 15.0.3
 
IFORT_HOME = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187
 
IFORT_BIN_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/bin/intel64
 
IFORT_LIB_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/compiler/lib/intel64
 
IFORT_INC_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/compiler/include
 
IFORT_MAN_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/man/en_US
 
IFORT_DOC_DIR = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/Documentation/en_US
 
LANGUAGE_TERRITORY = en_US
 
PATH = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/bin/intel64:$PATH
 
LD_LIBRARY_PATH = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187:$LD_LIBRARY_PATH/composer_xe_2015.3.187/compiler/lib/intel64
 
LD_RUN_PATH = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/compiler/lib/intel64:$LD_RUN_PATH
 
MIC_LD_LIBRARY_PATH = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/mpirt/lib/mic:$MIC_LD_LIBRARY_PATH
 
MIC_LD_LIBRARY_PATH = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/compiler/lib/mic:$MIC_LD_LIBRARY_PATH
 
MIC_LIBRARY_PATH = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/mpirt/lib/mic:$MIC_LIBRARY_PATH
 
MIC_LIBRARY_PATH = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/compiler/lib/mic:$MIC_LIBRARY_PATH
 
LIBRARY_PATH = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/compiler/lib/intel64:$LIBRARY_PATH
 
MANPATH = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/man/en_US:$MANPATH
 
NLSPATH = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/compiler/lib/intel64/locale/%l_%t/%N:$NLSPATH
 
INTEL_PYTHONHOME = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/debugger/python/intel64:$INTEL_PYTHONHOME
 
PATH = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/debugger/gdb/intel64/bin:$PATH
 
LD_LIBRARY_PATH = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/debugger/libipt/intel64/lib:$LD_LIBRARY_PATH
 
MANPATH = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/debugger/gdb/intel64/share/man:$MANPATH
 
INFOPATH = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/debugger/gdb/intel64/share/info:$INFOPATH
 
NLSPATH = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/debugger/gdb/intel64/share/locale/%l_%t/%N:$NLSPATH
 
INTEL_LICENSE_FILE = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/composer_xe_2015.3.187/licenses
 
CC = icc
 
CXX = icpc
 
F77 = ifort
 
FC = ifort
 
F90 = ifort
 
TEST_MODULE_SCRIPT = /opt/bwhpc/common/compiler/intel/compxe.2015.3.187/install-doc/test-compiler-intel.sh
 
TEST_MODULE_NAME = compiler/intel/15.0
 
[...]
 
 
</pre>
 
</pre>
 
<br>
 
<br>
Line 183: Line 110:
 
== Local documentation ==
 
== Local documentation ==
 
For version specific documentation see the help page of the module. For example
 
For version specific documentation see the help page of the module. For example
  +
<pre>
''''module help compiler/intel'''' will show the information for the default version.
 
  +
$ module help compiler/intel
  +
</pre>
  +
will show the information for the default version.
  +
<!--
 
<pre>$ module help compiler/intel
 
<pre>$ module help compiler/intel
 
----------- Module Specific Help for 'compiler/intel/15.0' --------
 
----------- Module Specific Help for 'compiler/intel/15.0' --------
Line 219: Line 150:
 
module show compiler/intel/15.0
 
module show compiler/intel/15.0
 
[...]</pre>
 
[...]</pre>
  +
!-->
   
 
== Manual Pages ==
 
== Manual Pages ==
Line 227: Line 159:
 
$ man ifort
 
$ man ifort
 
$ man idb
 
$ man idb
  +
$ man gdb-ia
 
</pre>
 
</pre>
 
<br>
 
<br>

Revision as of 12:12, 19 May 2017

Description Content
module load compiler/intel
License Commercial. See $INTEL_HOME/install-doc/EULA.txt. | Intel Product Licensig FAQ
Citing n/a
Links Intel C-Compiler Homepage
Graphical Interface Yes (Intel Debugger GUI-Verison)
Included modules icc | icpc | ifort | idb | gdb-ia


1 Introduction

The Intel Compiler of the Intel Composer XE Suite consists of tools to compile and debug C, C++ and Fortran programs:

icc Intel C compiler
icpc Intel C++ compiler
ifort Intel Fortran compiler
idb Intel debugger in GUI mode (until version 14 only)
gdb-ia Intel version of GNU debugger in console mode (from version 15)
idbc Intel debugger in console mode (until version 14 only)

The intel compiler suite also includes the TBB (Threading Building Blocks) and IPP (Integrated Performance Primitives) libraries.

More information about the MPI versions of the Intel Compiler is available here:

2 Versions and Availability

A list of versions currently available on all bwHPC Clusters can be obtained from the cluster information system
Cluster Information System

On the command line interface of any bwHPC cluster you'll get a list of available versions by executing:

$ module avail compiler/intel



2.1 Loading the module

2.1.1 Default Version

You can load the default version of the Intel Compiler with the command

$ module load compiler/intel


If loading the module fails, check if you have already loaded the module with 'module list'.

2.1.2 Specific (newer or older) Version

If you wish to load a specific (older or newer) version (if available), add the specific version number of the intel compiler, e.g. for loading Intel compiler suite 14.0, execute:

$ module unload compiler/intel
$ module   load compiler/intel/14.0

Note: Only one compiler can be loaded in your active session, hence, before loading a new intel compiler version you must to unload the current loaded version.

For unloading the intel compiler the version number is not required:

$ module unload compiler/intel

unloads any currently loaded intel compiler version.


3 Intel Compiler Specific Environment Variables

To see a list of all Intel Compiler environment variables set by the 'module load' command execute:

module show compiler/intel


4 Documentation

4.1 Online documentation

4.2 Local documentation

For version specific documentation see the help page of the module. For example

$ module help compiler/intel

will show the information for the default version.

4.3 Manual Pages

For detailed lists of the different program options consult the particular man page

$ man icc
$ man icpc
$ man ifort
$ man idb
$ man gdb-ia


5 Debugger

5.1 GUI

The Intel Debugger is an Eclipse Rich Client Platform based GUI driven Debugger with exciting features for parallelism and threading.

Start the GUI-debugger with the command 'idb [binary-file-name] &'. Intel Debugger.jpg

5.2 Console Mode

5.2.1 Intel Debugger

The console-mode Intel debugger will be started using the command 'idbc [binary-file]'.

idbc module_avail_grep
Intel(R) Debugger for applications running on Intel(R) 64, Version 13.0, Build [80.483.23]
------------------ 
object file name: module_avail_grep 
Reading symbols from /pfs/data2/home/kn/kn_kn/kn_pop235844/module_avail_grep...done.
(idb) help
List of classes of commands:

    breakpoints -- Commands for manipulation with breakpoints.
    data        -- Examining data.
    extensions  -- Idb extension commands.
    files       -- Specifying and examing files.
    obscure     -- Obscure features.
    openmp      -- OpenMP support.
    parallel    -- MPI support.
    running     -- Running the program.
    stack       -- Examining the stack.
    status      -- Status inquiries.
    support     -- Support facilities.

To display help on a particular command, enter "help" followed by the command
name. Command name abbreviations are allowed if unambiguous.


5.2.2 GNU for Intel Debugger

To debug applications natively on IA-32 or Intel64 Architecture systems, you may also use GDB with the following command: 'gdb-ia'.
The actual debugger usage is the same as for the GNU Project Debugger. Extensions for IA-32/Intel 64Architecture are described in the debugger documentation.

$ gdb-ia ./structure
[...]
GNU gdb (GDB) 7.5-1.0.81
Copyright (C) 2012 Free Software Foundation, Inc; (C) 2013-2014 Intel Corp.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.  Type "show copying"
and "show warranty" for details.
This GDB was configured as "x86_64-unknown-linux-gnu".
For information about how to find Technical Support, Product Updates,              
User Forums, FAQs, tips and tricks, and other support information, please visit:
<http://www.intel.com/software/products/support/>...
Reading symbols from /pfs/data1/software_uc1/bwhpc/common/bio/structure/2.3.4/console/structure...done.
[...]
(gdb)

More GDB-Infos here...

6 Optimizations

You can turn on various optimization options to enhance the performance of your program. Which options are the best depends on the specific program and can be determined by benchmarking your code. A command which gives good performance and a decent file size is icc -xHost -O2 ex.c.
There are more aggressive optimization flags and levels (e.g. -O3 or -fast and implied options) but the compiled programs can get quite large due to inlining. Additionally the compilation process will probably take longer. Moreover it may happen that the compiled program is even slower -- or may require installation of additional statically-linked libraries. Such a command would be for example: icc -fast ex.c

7 Profiling

Profiling an application means augmenting the compiled binary with information on execution counts per source-line (and basic blocks) -- e.g. one may see how many times an if-statement has been evaluated to true. To do so, compile your code with the profile flag: icc -p ex.c -o ex.
Using the gprof tool, one may manually inspect execution count of each executed line of source code.
For compiler optimization, recompile Your source using icc -prof-gen ex.c -o ex then execute the most co]]mmon and typical use-case of your application, and then recompile using the generated profile count (and using optimization): icc -prof-use -O2 ex.c -o ex.

7.1 Further literature

A tutorial on optimization can be found at Compiler-Essentials.pdf and to get the different optimization options execute icc -help opt icc -help advanced
or the previously described catch-all option -v --help.