Difference between revisions of "Development/Intel Compiler"

From bwHPC Wiki
Jump to: navigation, search
 
(59 intermediate revisions by 9 users not shown)
Line 1: Line 1:
  +
{{Softwarepage|compiler/intel}}
−
<!--{| align="right" {{Table|width=40%}} -->
  
  +
−
{|{{Softwarebox}}
  
  +
{| width=600px class="wikitable"
 
|-
  
|-
  +
! Description !! Content
−
! colspan="2" style="text-align:center" | Intel Compiler
  
 
|-
  
|-
 
| module load
  
| module load
−
| compiler/intel/xxx
 +
| compiler/intel
 
|-
  
|-
 
| License
  
| License
  +
| Commercial. See $INTEL_HOME/install-doc/EULA.txt. &#124; [https://software.intel.com/en-us/faq/licensing Intel Product Licensing FAQ]
−
| GPL
  
 
|-
  
|-
 
|Citing
  
|Citing
−
|
+
| n/a
 
|-
  
|-
 
| Links
  
| Links
−
| [https://software.intel.com/en-us/c-compilers Homepage]
 +
| [https://software.intel.com/en-us/c-compilers Intel C-Compiler Homepage]
−
|
 
 
|-
  
|-
 
| Graphical Interface
  
| Graphical Interface
  +
| [[#Debugger|Yes (Intel Debugger GUI-Verison)]]
−
| No
  
 
|-
  
|-
−
| Included in module
 +
| Included modules
−
| icc, icpc, ifort, idb
 +
| icc &#124; icpc &#124; ifort &#124; idb &#124; gdb-ia
 
|}
  
|}
  +
<br>
−  
  +
= 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=500px class="wikitable"
−
{| border="1" style="margin:5px;border-collapse:collapse"
  
 
|-
  
|-
 
|style="padding:3px"| icc
  
|style="padding:3px"| icc
−
|style="padding:3px"| Intel C compiler
 +
|style="padding:3px"| Intel C compiler
 
|-
  
|-
 
|style="padding:3px"| icpc
  
|style="padding:3px"| icpc
Line 34: 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>
  +
More information about the MPI versions of the Intel Compiler is available here:
  +
* [[Development/Parallel_Programming|Best Practices Guide for Parallel Programming]].
  +
<br>
   
  +
= Documentation =
−
Aside from that the suite also includes the TBB (Threading Building Blocks) and IPP (Integrated Performance Primitives) libraries.
  
  +
== Online 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]
   
  +
= Debugger =
−
'''Loading:''' There are different versions of the Intel compilers installed. To get a list of these installations execute the following command:
  
  +
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
−
<pre>$ module avail compiler/intel</pre>
  
  +
<br>
−
There is a default version which will be loaded when no version is explicitly specified, so the command
  
  +
http://www.bwhpc-c5.de/wiki/index.php/DDT
−
<pre>$ module load compiler/intel</pre>
  
  +
<br><br>
−
will load the default version.
  
−  
−
'''Online documentation:'''
  
−
http://software.intel.com/en-us/articles/intel-c-composer-xe-documentation
  
−  
−
'''Local documentation:''' For version specific documentation see the help page of the module. For example
  
−
<pre>$ module help compiler/intel</pre>
  
−
will show the information for the default version.
  
−
For detailed lists of the different program options consult the particular man page:
  
−
<pre>
  
−
$ man icc
  
−
$ man icpc
  
−
$ man ifort
  
−
$ man idb
  
−
</pre>
  
−  
−
'''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
  
−
<pre>$ icc -xHost -O2 ex.c</pre>
  
   
  +
= 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''').
  +
<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:
−
<pre>$ icc -fast ex.c</pre>
 +
'''icc -fast ex.c'''
  +
<br>
  +
<br>
   
−
'''Profiling:'''
 +
= 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:
  
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:
−
<pre>$ icc -p ex.c -o ex</pre>
 +
'''icc -p ex.c -o ex'''.
  +
<br>
 
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>
−  
−
For compiler optimization, recompile Your source using
+
For compiler optimization, recompile your source using
−
<pre>$ icc --prof-gen ex.c -o ex</pre>
 +
'''icc -prof-gen ex.c -o ex'''
−
then execute the most common 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):
−
<pre>$ icc --prof-use -O2 ex.c -o ex</pre>
 +
'''icc -prof-use -O2 ex.c -o ex'''.
  +
<br>
−  
−
'''Further literature:'''
 +
== Further literature ==
−
A tutorial on optimization can be found at http://download-software.intel.com/sites/default/files/article/301481/compiler-essentials.1.pdf
 +
A tutorial on optimization can be found at [https://software.intel.com/sites/default/files/managed/c1/61/compiler-essentials.1.pdf Compiler-Essentials.pdf]
 
and to get the different optimization options execute
  
and to get the different optimization options execute
  +
'''icc -help opt'''
−
<pre>
  
−
$ icc -help opt
 +
'''icc -help advanced'''
  +
<br>
−
$ icc -help advanced
  
  +
or the previously described catch-all option '''''-v --help'''''.
−
</pre>
  
−
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"