- Example of configuring, building, reconfiguring, rebuilding:

$ mkdir build

$ cd build

$ make all common

...

$ make clean

$ make all common

...

$ rm -rf *

$ make all common

- Notice in the example how the compiler definitions are only specified

for an empty build directory, but other Build options are used at any time.

$ cmake -DCMAKE_C_COMPILER=<C Compiler> -DCMAKE_CXX_COMPILER=<C++ Compiler> ..

[ Intel(R) Many Integrated Core Library (Intel(R) MIC Library) ]

[ Windows Libraries ]

$ cmake -G "Unix Makefiles" -DCMAKE_C_COMPILER=<C Compiler> -DCMAKE_CXX_COMPILER=<C++ Compiler> -DCMAKE_ASM_MASM_COMPILER=[ml | ml64] -DCMAKE_BUILD_TYPE=Release ..

On OS X* machines, it is possible to build universal (or fat) libraries which

include both IA-32 architecture and Intel(R) 64 architecture objects in a

single archive; just build the 32 and 32e libraries separately:

$ make

$ make

then invoke make again with a special argument as follows:

$ make fat

- The fat libraries will be put in exports/mac_32e/lib while the "thin" libraries

will be in exports/mac_32e/lib.thin and exports/mac_32/lib.thin

-DCMAKE_Fortran_COMPILER=<Fortran compiler name>

Unix* systems (Optional as compiler is default):

-DCMAKE_ASM_MASM_COMPILER=[ml | ml64 ]

This option is Windows* Only

==========================

==== Operating System ====

==========================

* Operating system can be lin (Linux*), mac (Mac*), or win (Windows*).

If not specified, cmake will try to determine your current operating system.

======================

==== Architecture ====

======================

* Architecture can be 32 (IA-32 architecture), 32e (Intel(R) 64 architecture),

arm (ARM architecture), aarch64 (ARMv8 architecture), ppc64 (PPC64 architecture),

or ppc64le (little endian PPC64 architecture).

* This option, by default is chosen based on the probing the compiler for

architecture macros (e.g., is __x86_64__ predefined by compiler?).

---- First values listed are the default value ----

Library type can be normal, profile, or stubs.

-DCMAKE_BUILD_TYPE=Release|Debug|RelWithDebInfo

Build type can be Release, Debug, or RelWithDebInfo.

libiomp5 version can be 5 or 4.

OpenMP version can be either 40 or 30.

Intel(R) MIC Architecture, can be knf or knc.

Should the Fortran modules be created (requires Fortran compiler)

Should include stats-gathering code?

Should OMPT support be turned on?

If ompt_support is off, then both ompt_blame and ompt_trace are ignored.

should OMPT blame functionality be turned on?

should OMPT trace functionality be turned on?

=====================

After the library has been built, there are five optional microtests that

can be performed. Some will be skipped based upon the platform.

These tests can be turned on (default) or off with the following options:

for correct instruction set?

$ make libiomp-micro-tests

which runs the tests.

============================================

- These flags are *appended*. They do not

overwrite any of the preset flags.

(typically additional -Ddef=val flags)

to during link phase

===================================

==== Feature Based Compilation ====

===================================

Should the build imitate build.pl's build process.

When this is true, the Unix* Release builds will build libiomp5

with -O2 and -g flags activated (same as RelWithDebInfo). Then,

the debug info is stripped out of the library and put into libiomp5.dbg

This is done for interaction with Intel(R) Parallel Amplifier.

Should adaptive (TSX-based) locks be included?

These are x86 specific. This feature is turned on by default

for IA-32 architecture and Intel(R) 64 architecture.

Otherwise, it is turned off.

Should 4096-byte alignment be used for certain data structures?

This option is useful on multinode systems where a small CACHE_LINE

setting leads to false sharing. This option is off by default.

Should versioned symbols be used for building the library?

This option only makes sense for ELF based libraries where version

symbols are supported (Linux, some BSD* variants). It is off

by default for Windows and Mac, but on for other Unix based operating

systems.

Should the predefined linker flags in CommonFlags.cmake be included

in the link command? This is true by default and should work for

Linux*, Mac*, and Windows*. The --version-script flag on Unix* based

---- With Various Options ----

- Build the 32 bit Linux library using GCC*

- Build the 32 bit debug Mac library using Clang*

- Build the library (architecture determined by probing compiler) using the

Intel(R) C Compiler and the Intel(R) C++ Compiler. Also, create the fortran modules using

the Intel(R) Fortran Compiler, enabling the libiomp-micro-tests target and using similar rules that build.pl

would use to build the library.

- Have CMake Find the C/C++ compiler, and specify additional flags for the C compiler, preprocessor, and C++ compiler.

---- Build the stubs library ----

=========

Footnotes