Development/Intel Compiler: Difference between revisions

From bwHPC Wiki
Jump to navigation Jump to search
(Update Intel Compiler for LLVM-based / OneAPI)
 
(78 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Softwarepage|compiler/intel}}
{| style="border-style: solid; border-width: 1px"
! Navigation: [[BwHPC_Best_Practices_Repository|bwHPC BPR]]
|}

= General compiler usage =

The basic operations can be performed with the same commands for all available compilers. For advanced usage such as optimization and profiling you should consult the best practice guide of the compiler you intend to use ([[BwHPC_BPG_Compiler#GCC|GCC]], [[BwHPC_BPG_Compiler#Intel Suite|Intel Suite]]). To get a list of the compilers installed on the system execute
<pre>$ module avail compiler</pre>
Both Intel and GCC have compilers for different languages which will be available after the module is loaded.


{| width=600px class="wikitable"
{| border="1" style="margin:5px;border-collapse:collapse"
|-
|-
! Description !! Content
! Compiler Suite
! Language
! Command
|-
|-
| module load
| rowspan="3" | Intel Composer
| compiler/intel/VERSION and compiler/intel/VERSION_llvm
| C
| icc
|-
|-
| C++
| License
| Commercial. See $INTEL_HOME/install-doc/EULA.txt. &#124; [https://software.intel.com/en-us/faq/licensing Intel Product Licensing FAQ]
| icpc
|-
|-
|Citing
| Fortran
| ifort
| n/a
|-
|-
| Links
| rowspan="3" | GCC
| [https://software.intel.com/en-us/c-compilers Intel C-Compiler Homepage]
| C
| gcc
|-
|-
| Graphical Interface
| C++
| [[#Debugger|Yes (Intel Debugger GUI-Verison)]]
| g++
|-
|-
| Included modules
| Fortran
| icc &#124; icpc &#124; ifort &#124; idb &#124; gdb-ia
| gfortran
|}
|}
<br>

= Introduction =
The following compiler commands work for all the compilers in the list above even though the examples will be for icc only. When ex.c is a C source code file such as
The '''Intel Compiler''' consists of tools to compile and debug C, C++ and Fortran programs, and currently is in a transition phase: the so-called legacy compiler (based on an Intel in-house development with many optimization hints) and the newer LLVM-based compiler (where many of these optimizations and hints are ported to). To smoothly handle this transition we offer the standard legacy compiler plus the new LLVM-based compiler with the ''_llvm'' prefix.
<source lang=C>
The following table shows the preferred names:
#include <stdio.h>
{| width=600px class="wikitable"
int main() {
printf("Hello world\n");
return 0;
}
</source>
it can be compiled and linked with the single command
<pre>$ icc ex.c -o ex</pre>
to produce an executable named ex.
This process can be divided into two steps:
<pre>
$ icc -c ex.c
$ icc ex.o -o ex
</pre>
When using libraries you must sometimes specify where the include files are (option -I) and where the library files are (option -L). In addition you have to tell the compiler which library you want to use (option -l). For example after loading the module numlib/fftw you can compile code for fftw using
<pre>
$ icc -c ex.c -I$FFTW_INC_DIR
$ icc ex.o -o ex -L$FFTW_LIB_DIR -lfftw3
</pre>

To inspect what exactly your program does (e.g. when the program crashes), you can run a debugger. To use the debugger properly with your program you have to compile it with debug information (option -g):
<pre>$ icc -g ex.c -o ex</pre>

= Intel Suite =
The Intel Composer XE Suite consists of tools to compile and debug C, C++ and Fortran programs:
{| border="1" style="margin:5px;border-collapse:collapse"
|-
|-
|style="padding:3px"| '''Tool'''
| icc
|style="padding:3px"| '''Legacy name'''
| Intel C compiler
|style="padding:3px"| '''LLVM-based name'''
|-
|-
| icpc
| Intel C++ compiler
|-
|-
|style="padding:3px"| Intel C compiler
| ifort
|style="padding:3px"| icc
| Intel Fortran compiler
|style="padding:3px"| icx
|-
|-
|style="padding:3px"| Intel C++ compiler
| idb
|style="padding:3px"| icpc
| Intel debugger in GUI mode
|style="padding:3px"| icpx
|-
|-
|style="padding:3px"| [https://software.intel.com/en-us/fortran-compilers Intel Fortran compiler]
| idbc
|style="padding:3px"| ifort
| Intel debugger in console mode
|style="padding:3px"| ifx
|-
|style="padding:3px"| Intel debugger in GUI mode (until version 14 only)
|style="padding:3px"| [[#GUI|idb]]
|style="padding:3px"| N/A
|-
|style="padding:3px"| Intel GNU debugger in console mode (from version 15)
|style="padding:3px"| [[#Console Mode|gdb-ia]]
|style="padding:3px"| gdb-oneapi
|-
|style="padding:3px"| Intel debugger in console mode (until version 14 only)
|style="padding:3px"| [[#Console Mode|idbc]]
|style="padding:3px"| N/A
|}
|}
The intel compiler suite also includes the TBB (Threading Building Blocks), IPP (Integrated Performance Primitives) and oneAPI libraries.

<br>
Aside from that the suite also includes the TBB (Threading Building Blocks) and IPP (Integrated Performance Primitives) libraries.
<br>

More information about the MPI versions of the Intel Compiler is available here:
'''Loading:''' There are different versions of the Intel compilers installed. To get a list of these installations execute the following command:
* [[Development/Parallel_Programming|Best Practices Guide for Parallel Programming]].
<pre>$ module avail compiler/intel</pre>
There is a default version which will be loaded when no version is explicitly specified, so the command
<pre>$ module load compiler/intel</pre>
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>
There are more aggressive optimization flags but the compiled programs can get quite large, e.g.
<pre>$ icc -fast ex.c</pre>
A tutorial on optimization can be found at http://download-software.intel.com/sites/default/files/article/301481/compiler-essentials.1.pdf
and to get the different optimization options execute
<pre>
$ icc -help opt
$ icc -help advanced
</pre>

'''Profiling:''' If you want to profile your program using gprof you have to compile your code with the profile flag:
<pre>$ icc -p ex.c -o ex</pre>

= GCC =

bwUniCluster currently provides GNU compiler suite versions:
* 4.5
* 4.7 (default)
* 4.8
<br>
<br>
To load the default compiler suite execute in your terminal session:
<pre>
$ module load compiler/gnu
</pre>
To load your prefered version, e.g. 4.5, enter:
<pre>
$ module load compiler/gnu/4.5
</pre>
For details about unload or switching compiler suites, please see chapter [[BwUniCluster_Environment_Modules| environment modules]].


= Documentation =
== 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]


= Optimizations =
== Default GNU compiler suite - version 4.7 ==
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

'''icx -xHost -O2 ex.c'''.
This module provides the GNU compiler suite version 4.7.3
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''').
via commands 'gcc', 'g++' and 'gfortran' (see also 'http://gcc.gnu.org/').
The GNU compiler has been build with gmp-4.3.2, mpfr-2.4.2 and mpc-0.8.1.

The compiler suite contains:
<pre>
cpp # GNU pre processor
gcc # GNU C compiler
g++ # GNU C++ compiler
gfortran # GNU Fortran compiler (Fortran 77, 90 and 95)
</pre>
<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:
Libraries can be found under:
'''icx -fast ex.c'''
<pre>
$GNU_LIB_DIR = /opt/bwhpc/common/compiler/gnu/4.7.3/x86_64/lib64
</pre>
<br>
<br>
For local documentation consult the module help:
<pre>
$ module help compiler/gnu/4.7
</pre>
or the '''man pages''' of each compiler:
<pre>
$ man cpp
$ man gcc
$ man g++
$ man gfortran
</pre>
<br>
<br>

For further online documentation visit:
= Profiling =
* [http://gcc.gnu.org/onlinedocs/ http://gcc.gnu.org/onlinedocs/]
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:
'''icx -p ex.c -o ex'''.
<br>
<br>
Using the gprof tool, one may manually inspect execution count of each executed line of source code.
For details on library and include directories of this compiler suite please enter:
<pre>
$ module show compiler/gnu/4.7
</pre>
<br>
<br>
For compiler optimization, recompile your source using
Please do not add the gnu compiler module to any automatic environment setup
'''icx -prof-gen ex.c -o ex'''
procedure (neither to ~/.profile nor to ~/.bashrc).
then execute the most co]]mmon and typical use-case of your application, and then recompile using the generated profile count (and using optimization):
'''icx -prof-use -O2 ex.c -o ex'''.
<br>
== Further literature ==
A tutorial on optimization can be found at [https://www.intel.com/content/www/us/en/developer/articles/technical/vectorization-essential.html Vectorization Essentials]
and to get the different optimization options execute
'''icx -help opt'''
or
'''icx -help advanced'''
<br>
<br>
or the previously described catch-all option '''''-v --help'''''.
Please note, that the environment variables and commands are '''only''' available after loading this module.

Latest revision as of 15:17, 9 October 2024

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/VERSION and compiler/intel/VERSION_llvm
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


Introduction

The Intel Compiler consists of tools to compile and debug C, C++ and Fortran programs, and currently is in a transition phase: the so-called legacy compiler (based on an Intel in-house development with many optimization hints) and the newer LLVM-based compiler (where many of these optimizations and hints are ported to). To smoothly handle this transition we offer the standard legacy compiler plus the new LLVM-based compiler with the _llvm prefix. The following table shows the preferred names:

Tool Legacy name LLVM-based name
Intel C compiler icc icx
Intel C++ compiler icpc icpx
Intel Fortran compiler ifort ifx
Intel debugger in GUI mode (until version 14 only) idb N/A
Intel GNU debugger in console mode (from version 15) gdb-ia gdb-oneapi
Intel debugger in console mode (until version 14 only) idbc N/A

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

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


Documentation

Online documentation

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 icx -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: icx -fast ex.c

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: icx -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 icx -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): icx -prof-use -O2 ex.c -o ex.

Further literature

A tutorial on optimization can be found at Vectorization Essentials and to get the different optimization options execute icx -help opt or icx -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=13013"