Difference between revisions of "Development/Intel Compiler"

From bwHPC Wiki
Jump to: navigation, search
m (→‎Default Version)
 
(42 intermediate revisions by 8 users not shown)
Line 1: Line 1:
  +
{{Softwarepage|compiler/intel}}
  +
 
{| width=600px class="wikitable"
  
{| width=600px class="wikitable"
 
|-
  
|-
Line 5: Line 7:
 
| module load
  
| module load
 
| compiler/intel
  
| compiler/intel
−
|-
  
−
| Availability
  
−
| [[bwUniCluster]] | [[BwForCluster_Chemistry]]
  
 
|-
  
|-
 
| License
  
| License
−
| Commercial. See $INTEL_HOME/install-doc/EULA.txt. | [https://software.intel.com/en-us/faq/licensing Intel Product Licensig FAQ]
 +
| Commercial. See $INTEL_HOME/install-doc/EULA.txt. | [https://software.intel.com/en-us/faq/licensing Intel Product Licensing FAQ]
 
|-
  
|-
 
|Citing
  
|Citing
Line 22: Line 21:
 
|-
  
|-
 
| 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 35:
 
|-
  
|-
 
|style="padding:3px"| ifort
  
|style="padding:3px"| ifort
−
|style="padding:3px"| Intel Fortran compiler
 +
|style="padding:3px"| [https://software.intel.com/en-us/fortran-compilers Intel Fortran compiler]
 
|-
  
|-
−
|style="padding:3px"| 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"| idbc
 +
|style="padding:3px"| [[#Console Mode|gdb-ia]]
−
|style="padding:3px"| Intel debugger in console mode
 +
|style="padding:3px"| Intel version of GNU debugger in console mode (from version 15)
  +
|-
  +
|style="padding:3px"| [[#Console Mode|idbc]]
  +
|style="padding:3px"| 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.
 
<br>
  
<br>
−
Aside from that the suite also includes the TBB (Threading Building Blocks) and IPP (Integrated Performance Primitives) libraries.
  
 
<br>
  
<br>
  +
More information about the MPI versions of the Intel Compiler is available here:
−
= Versions and Availability =
  
  +
* [[Development/Parallel_Programming|Best Practices Guide for Parallel Programming]].
−
A list of versions currently available on all bwHPC-C5-Clusters can be obtained from the
  
−
<br>
  
−
<big>
  
−  
−
[https://cis-hpc.uni-konstanz.de/prod.cis/ Cluster Information System CIS]
  
−  
−
</big>
  
−
{{#widget:Iframe
  
−
|url=https://cis-hpc.uni-konstanz.de/prod.cis/bwUniCluster/compiler/intel
  
−
|width=99%
  
−
|height=480
  
−
}}
  
−
On the command line interface of any bwHPC cluster you'll get a list of available versions
 
−
by using the command 'module avail compiler/intel'.
  
−
<pre>
  
−
$ : bwUniCluster
  
−
$ 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>
  
−
<br>
  
−
== Loading the module ==
  
−
=== Default Version ===
  
−
You can load the default version of the Intel Compiler with the command
  
−
''''module load compiler/intel''''.
  
−
<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 list
  
−
Currently Loaded Modulefiles:
  
−
1) compiler/intel/15.0(default)
  
−
</pre>
  
−
Here, we got the "default" version 15.0 (example).
  
−
<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
 
−
with 'module list'.
  
−
<br>
  
−  
−
=== 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.
 
−
''''module load compiler/intel'''/version' to load the version you desires.
  
−
<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/14.0
  
−
$ module list
  
−
Currently Loaded Modulefiles:
  
−
1) compiler/intel/14.0
  
−
</pre>
  
−
Intel C-Compiler "version 14.0" is loaded now (example).
  
−
<br>
  
−
<br>
  
−  
−
= Intel C-Compiler-Specific Environments =
  
−
To see a list of all Intel C-Compiler environments set by the 'module load'-command use the command '''module show compiler/intel'''.
  
−
<br>
  
−
Example (excerpt, default version)
  
−
<pre>
  
−
$ module show compiler/intel # output is revised
  
−
-------------------------------------------------------------------
  
−
/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>
  
 
<br>
  
<br>
   
 
= Documentation =
  
= Documentation =
 
== Online documentation ==
  
== Online documentation ==
−
[http://software.intel.com/en-us/articles/intel-c-composer-xe-documentation Intel C-Compiler Documentation]
 +
* [https://software.intel.com/en-us/articles/intel-c-composer-xe-documentation Intel® C-Compiler Documentation]
  +
* [https://software.intel.com/en-us/intel-software-technical-documentation Intel® Software Documentation Library]
−
== 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.
  
−
<pre>$ module help compiler/intel</pre>
  
   
−
== Manual Pages ==
  
−
For detailed lists of the different program options consult the particular man page
  
−
<pre>
  
−
$ man icc
  
−
$ man icpc
  
−
$ man ifort
  
−
$ man idb
  
−
</pre>
  
−
<br>
  
 
= Debugger =
  
= Debugger =
  +
Please use DDT. It is a parallel debugger with graphical user interface and can also be used for debugging serial programs. The description of the debugger can be found on the website
−
== GUI ==
  
−
The Intel® Debugger is an Eclipse Rich Client Platform based GUI driven Debugger with exciting features for parallelism and threading.
  
−
* [https://software.intel.com/sites/default/files/04/0d/idb-linux-12.pdf Intel Debugger for Linux]
  
−
* [https://software.intel.com/en-us/search/gss/intel%20debugger%20gui More Infos...]
  
−
Start the GUI-debugger with the command ''''idb [binary-file-name] &''''.
  
−
[[File:Intel_Debugger.jpg]]
  
−
<br>
  
−  
−
== Console Mode ==
  
−
The console-mode Intel debugger will be started using the command ''''idbc [binary-file]''''.
  
−
<pre>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.
  
−
</pre>
  
 
<br>
  
<br>
  +
http://www.bwhpc-c5.de/wiki/index.php/DDT
  +
<br><br>
   
 
= Optimizations =
 
= 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
  
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'''.
  
'''icc -xHost -O2 ex.c'''.
  +
With the option '''-xHost''' instructions for the highest instruction set available on the compilation host processor are generated. If you want to generate optimal code on bwUniCluster for both nodes with Sandy Bridge architecture and nodes with Broadwell architecture, you must compile your code with the options '''-xAVX -axCORE-AVX2''' (instead of '''-xHost''').
 
<br>
  
<br>
 
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:
  
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:
Line 244: Line 80:
 
Using the gprof tool, one may manually inspect execution count of each executed line of source code.
  
Using the gprof tool, one may manually inspect execution count of each executed line of source code.
 
<br>
  
<br>
−
For compiler optimization, recompile Your source using
+
For compiler optimization, recompile your source using
 
'''icc -prof-gen ex.c -o ex'''
  
'''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):
  
then execute the most co]]mmon and typical use-case of your application, and then recompile using the generated profile count (and using optimization):
Line 256: Line 92:
 
<br>
  
<br>
 
or the previously described catch-all option '''''-v --help'''''.
  
or the previously described catch-all option '''''-v --help'''''.
−  
−
<!--
  
−
[[Category:Compiler_software]][[Category:bwUniCluster]]
  
−
-->
  

Latest revision as of 23:57, 8 December 2022

The main documentation is available via module help compiler/intel on the cluster. Most software modules for applications provide working example batch scripts.


Description Content
module load compiler/intel
License Commercial. See $INTEL_HOME/install-doc/EULA.txt. | Intel Product Licensing 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 Documentation

2.1 Online documentation

3 Debugger

Please use DDT. It is a parallel debugger with graphical user interface and can also be used for debugging serial programs. The description of the debugger can be found on the website
http://www.bwhpc-c5.de/wiki/index.php/DDT

4 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. With the option -xHost instructions for the highest instruction set available on the compilation host processor are generated. If you want to generate optimal code on bwUniCluster for both nodes with Sandy Bridge architecture and nodes with Broadwell architecture, you must compile your code with the options -xAVX -axCORE-AVX2 (instead of -xHost).
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

5 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.

5.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.

Retrieved from "https://wiki.bwhpc.de/wiki/index.php?title=Development/Intel_Compiler&oldid=11600"