openmp/README.rst

   1 ========================================
   2 How to Build the LLVM* OpenMP* Libraries
   3 ========================================
   4 This repository requires `CMake <http://www.cmake.org/>`_ v2.8.0 or later.  LLVM
   5 and Clang need a more recent version which also applies for in-tree builds.  For
   6 more information than available in this document please see
   7 `LLVM's CMake documentation <https://llvm.org/docs/CMake.html>`_ and the
   8 `official documentation <https://cmake.org/cmake/help/v2.8.0/cmake.html>`_.
   9
  10 .. contents::
  11    :local:
  12
  13 How to Call CMake Initially, then Repeatedly
  14 ============================================
  15 - When calling CMake for the first time, all needed compiler options must be
  16   specified on the command line.  After this initial call to CMake, the compiler
  17   definitions must not be included for further calls to CMake.  Other options
  18   can be specified on the command line multiple times including all definitions
  19   in the build options section below.
  20 - Example of configuring, building, reconfiguring, rebuilding:
  21
  22   .. code-block:: console
  23
  24     $ mkdir build
  25     $ cd build
  26     $ cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ ..  # Initial configuration
  27     $ make
  28     ...
  29     $ make clean
  30     $ cmake -DCMAKE_BUILD_TYPE=Debug ..                               # Second configuration
  31     $ make
  32     ...
  33     $ rm -rf *
  34     $ cmake -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++ ..        # Third configuration
  35     $ make
  36
  37 - Notice in the example how the compiler definitions are only specified for an
  38   empty build directory, but other build options are used at any time.
  39 - The file ``CMakeCache.txt`` which is created after the first call to CMake is
  40   a configuration file which holds all values for the build options.  These
  41   values can be changed using a text editor to modify ``CMakeCache.txt`` as
  42   opposed to using definitions on the command line.
  43 - To have CMake create a particular type of build generator file simply include
  44   the ``-G <Generator name>`` option:
  45
  46   .. code-block:: console
  47
  48     $ cmake -G "Unix Makefiles" ...
  49
  50   You can see a list of generators CMake supports by executing the cmake command
  51   with no arguments.
  52
  53 Instructions to Build
  54 =====================
  55 .. code-block:: console
  56
  57  $ cd openmp_top_level/ [ this directory with libomptarget/, runtime/, etc. ]
  58  $ mkdir build
  59  $ cd build
  60
  61  [ Unix* Libraries ]
  62  $ cmake -DCMAKE_C_COMPILER=<C Compiler> -DCMAKE_CXX_COMPILER=<C++ Compiler> ..
  63
  64  [ Windows* Libraries ]
  65  $ cmake -G <Generator Type> -DCMAKE_C_COMPILER=<C Compiler> -DCMAKE_CXX_COMPILER=<C++ Compiler> -DCMAKE_ASM_MASM_COMPILER=[ml | ml64] -DCMAKE_BUILD_TYPE=Release ..
  66
  67  $ make
  68  $ make install
  69
  70 CMake Options
  71 =============
  72 Builds with CMake can be customized by means of options as already seen above.
  73 One possibility is to pass them via the command line:
  74
  75 .. code-block:: console
  76
  77   $ cmake -DOPTION=<value> path/to/source
  78
  79 .. note:: The first value listed is the respective default for that option.
  80
  81 Generic Options
  82 ---------------
  83 For full documentation consult the CMake manual or execute
  84 ``cmake --help-variable VARIABLE_NAME`` to get information about a specific
  85 variable.
  86
  87 **CMAKE_BUILD_TYPE** = ``Release|Debug|RelWithDebInfo``
  88   Build type can be ``Release``, ``Debug``, or ``RelWithDebInfo`` which chooses
  89   the optimization level and presence of debugging symbols.
  90
  91 **CMAKE_C_COMPILER** = <C compiler name>
  92   Specify the C compiler.
  93
  94 **CMAKE_CXX_COMPILER** = <C++ compiler name>
  95   Specify the C++ compiler.
  96
  97 **CMAKE_Fortran_COMPILER** = <Fortran compiler name>
  98   Specify the Fortran compiler. This option is only needed when
  99   **LIBOMP_FORTRAN_MODULES** is ``ON`` (see below).  So typically, a Fortran
 100   compiler is not needed during the build.
 101
 102 **CMAKE_ASM_MASM_COMPILER** = ``ml|ml64``
 103   This option is only relevant for Windows*.
 104
 105 Options for all Libraries
 106 -------------------------
 107
 108 **OPENMP_ENABLE_WERROR** = ``OFF|ON``
 109   Treat warnings as errors and fail, if a compiler warning is triggered.
 110
 111 **OPENMP_LIBDIR_SUFFIX** = ``""``
 112   Extra suffix to append to the directory where libraries are to be installed.
 113
 114 **OPENMP_TEST_C_COMPILER** = ``${CMAKE_C_COMPILER}``
 115   Compiler to use for testing. Defaults to the compiler that was also used for
 116   building.
 117
 118 **OPENMP_TEST_CXX_COMPILER** = ``${CMAKE_CXX_COMPILER}``
 119   Compiler to use for testing. Defaults to the compiler that was also used for
 120   building.
 121
 122 **OPENMP_LLVM_TOOLS_DIR** = ``/path/to/built/llvm/tools``
 123   Additional path to search for LLVM tools needed by tests.
 124
 125 **OPENMP_LLVM_LIT_EXECUTABLE** = ``/path/to/llvm-lit``
 126   Specify full path to ``llvm-lit`` executable for running tests.  The default
 127   is to search the ``PATH`` and the directory in **OPENMP_LLVM_TOOLS_DIR**.
 128
 129 **OPENMP_FILECHECK_EXECUTABLE** = ``/path/to/FileCheck``
 130   Specify full path to ``FileCheck`` executable for running tests.  The default
 131   is to search the ``PATH`` and the directory in **OPENMP_LLVM_TOOLS_DIR**.
 132
 133 **OPENMP_NOT_EXECUTABLE** = ``/path/to/not``
 134   Specify full path to ``not`` executable for running tests.  The default
 135   is to search the ``PATH`` and the directory in **OPENMP_LLVM_TOOLS_DIR**.
 136
 137 Options for ``libomp``
 138 ----------------------
 139
 140 **LIBOMP_ARCH** = ``aarch64|arm|i386|loongarch64|mic|mips|mips64|ppc64|ppc64le|x86_64|riscv64``
 141   The default value for this option is chosen based on probing the compiler for
 142   architecture macros (e.g., is ``__x86_64__`` predefined by compiler?).
 143
 144 **LIBOMP_MIC_ARCH** = ``knc|knf``
 145   Intel(R) Many Integrated Core Architecture (Intel(R) MIC Architecture) to
 146   build for.  This value is ignored if **LIBOMP_ARCH** does not equal ``mic``.
 147
 148 **LIBOMP_LIB_TYPE** = ``normal|profile|stubs``
 149   Library type can be ``normal``, ``profile``, or ``stubs``.
 150
 151 **LIBOMP_USE_VERSION_SYMBOLS** = ``ON|OFF``
 152   Use versioned symbols for building the library.  This option only makes sense
 153   for ELF based libraries where version symbols are supported (Linux*, some BSD*
 154   variants).  It is ``OFF`` by default for Windows* and macOS*, but ``ON`` for
 155   other Unix based operating systems.
 156
 157 **LIBOMP_ENABLE_SHARED** = ``ON|OFF``
 158   Build a shared library.  If this option is ``OFF``, static OpenMP libraries
 159   will be built instead of dynamic ones.
 160
 161   .. note::
 162
 163     Static libraries are not supported on Windows*.
 164
 165 **LIBOMP_FORTRAN_MODULES** = ``OFF|ON``
 166   Create the Fortran modules (requires Fortran compiler).
 167
 168 macOS* Fat Libraries
 169 """"""""""""""""""""
 170 On macOS* machines, it is possible to build universal (or fat) libraries which
 171 include both i386 and x86_64 architecture objects in a single archive.
 172
 173 .. code-block:: console
 174
 175   $ cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_OSX_ARCHITECTURES='i386;x86_64' ..
 176   $ make
 177
 178 There is also an option **LIBOMP_OSX_ARCHITECTURES** which can be set in case
 179 this is an LLVM source tree build. It will only apply for the ``libomp`` library
 180 avoids having the entire LLVM/Clang build produce universal binaries.
 181
 182 Optional Features
 183 """""""""""""""""
 184
 185 **LIBOMP_USE_ADAPTIVE_LOCKS** = ``ON|OFF``
 186   Include adaptive locks, based on Intel(R) Transactional Synchronization
 187   Extensions (Intel(R) TSX).  This feature is x86 specific and turned ``ON``
 188   by default for IA-32 architecture and Intel(R) 64 architecture.
 189
 190 **LIBOMP_USE_INTERNODE_ALIGNMENT** = ``OFF|ON``
 191   Align certain data structures on 4096-byte.  This option is useful on
 192   multi-node systems where a small ``CACHE_LINE`` setting leads to false sharing.
 193
 194 **LIBOMP_OMPT_SUPPORT** = ``ON|OFF``
 195   Include support for the OpenMP Tools Interface (OMPT).
 196   This option is supported and ``ON`` by default for x86, x86_64, AArch64,
 197   PPC64, RISCV64 and LoongArch64 on Linux* and macOS*.
 198   This option is ``OFF`` if this feature is not supported for the platform.
 199
 200 **LIBOMP_OMPT_OPTIONAL** = ``ON|OFF``
 201   Include support for optional OMPT functionality.  This option is ignored if
 202   **LIBOMP_OMPT_SUPPORT** is ``OFF``.
 203
 204 **LIBOMP_STATS** = ``OFF|ON``
 205   Include stats-gathering code.
 206
 207 **LIBOMP_USE_DEBUGGER** = ``OFF|ON``
 208   Include the friendly debugger interface.
 209
 210 **LIBOMP_USE_HWLOC** = ``OFF|ON``
 211   Use `OpenMPI's hwloc library <https://www.open-mpi.org/projects/hwloc/>`_ for
 212   topology detection and affinity.
 213
 214 **LIBOMP_HWLOC_INSTALL_DIR** = ``/path/to/hwloc/install/dir``
 215   Specify install location of hwloc.  The configuration system will look for
 216   ``hwloc.h`` in ``${LIBOMP_HWLOC_INSTALL_DIR}/include`` and the library in
 217   ``${LIBOMP_HWLOC_INSTALL_DIR}/lib``.  The default is ``/usr/local``.
 218   This option is only used if **LIBOMP_USE_HWLOC** is ``ON``.
 219
 220 Additional Compiler Flags
 221 """""""""""""""""""""""""
 222
 223 These flags are **appended**, they do not overwrite any of the preset flags.
 224
 225 **LIBOMP_CPPFLAGS** = <space-separated flags>
 226   Additional C preprocessor flags.
 227
 228 **LIBOMP_CXXFLAGS** = <space-separated flags>
 229   Additional C++ compiler flags.
 230
 231 **LIBOMP_ASMFLAGS** = <space-separated flags>
 232   Additional assembler flags.
 233
 234 **LIBOMP_LDFLAGS** = <space-separated flags>
 235   Additional linker flags.
 236
 237 **LIBOMP_LIBFLAGS** = <space-separated flags>
 238   Additional libraries to link.
 239
 240 **LIBOMP_FFLAGS** = <space-separated flags>
 241   Additional Fortran compiler flags.
 242
 243 Options for ``libomptarget``
 244 ----------------------------
 245
 246 An installed LLVM package is a prerequisite for building ``libomptarget``
 247 library. So ``libomptarget`` may only be built in two cases:
 248
 249 - As a project of a regular LLVM build via **LLVM_ENABLE_PROJECTS**,
 250   **LLVM_EXTERNAL_PROJECTS**, or **LLVM_ENABLE_RUNTIMES** or
 251 - as a standalone project build that uses a pre-installed LLVM package.
 252   In this mode one has to make sure that the default CMake
 253   ``find_package(LLVM)`` call `succeeds <https://cmake.org/cmake/help/latest/command/find_package.html#search-procedure>`_.
 254
 255 **LIBOMPTARGET_OPENMP_HEADER_FOLDER** = ``""``
 256   Path of the folder that contains ``omp.h``.  This is required for testing
 257   out-of-tree builds.
 258
 259 **LIBOMPTARGET_OPENMP_HOST_RTL_FOLDER** = ``""``
 260   Path of the folder that contains ``libomp.so``, and ``libLLVMSupport.so``
 261   when profiling is enabled.  This is required for testing.
 262
 263 Options for ``NVPTX device RTL``
 264 --------------------------------
 265
 266 **LIBOMPTARGET_NVPTX_ENABLE_BCLIB** = ``ON|OFF``
 267   Enable CUDA LLVM bitcode offloading device RTL. This is used for link time
 268   optimization of the OMP runtime and application code. This option is enabled
 269   by default if the build system determines that `CMAKE_C_COMPILER` is able to
 270   compile and link the library.
 271
 272 **LIBOMPTARGET_NVPTX_CUDA_COMPILER** = ``""``
 273   Location of a CUDA compiler capable of emitting LLVM bitcode. Currently only
 274   the Clang compiler is supported. This is only used when building the CUDA LLVM
 275   bitcode offloading device RTL. If unspecified, either the Clang from the build
 276   itself is used (i.e. an in-tree build with LLVM_ENABLE_PROJECTS including
 277   clang), or the Clang compiler that the build uses as C compiler
 278   (CMAKE_C_COMPILER; only if it is Clang). The latter is common for a
 279   stage2-build or when using -DLLVM_ENABLE_RUNTIMES=openmp.
 280
 281 **LIBOMPTARGET_NVPTX_BC_LINKER** = ``""``
 282   Location of a linker capable of linking LLVM bitcode objects. This is only
 283   used when building the CUDA LLVM bitcode offloading device RTL. If
 284   unspecified, either the llvm-link in that same directory as
 285   LIBOMPTARGET_NVPTX_CUDA_COMPILER is used, or the llvm-link from the
 286   same build (available in an in-tree build).
 287
 288 **LIBOMPTARGET_NVPTX_ALTERNATE_HOST_COMPILER** = ``""``
 289   Host compiler to use with NVCC. This compiler is not going to be used to
 290   produce any binary. Instead, this is used to overcome the input compiler
 291   checks done by NVCC. E.g. if using a default host compiler that is not
 292   compatible with NVCC, this option can be use to pass to NVCC a valid compiler
 293   to avoid the error.
 294
 295  **LIBOMPTARGET_NVPTX_COMPUTE_CAPABILITIES** = ``35``
 296   List of CUDA compute capabilities that should be supported by the NVPTX
 297   device RTL. E.g. for compute capabilities 6.0 and 7.0, the option "60;70"
 298   should be used. Compute capability 3.5 is the minimum required.
 299
 300  **LIBOMPTARGET_NVPTX_DEBUG** = ``OFF|ON``
 301   Enable printing of debug messages from the NVPTX device RTL.
 302
 303 **LIBOMPTARGET_LIT_ARGS** = ``""``
 304   Arguments given to lit. ``make check-libomptarget`` and
 305   ``make check-libomptarget-*`` are affected. For example, use
 306   ``LIBOMPTARGET_LIT_ARGS="-j4"`` to force ``lit`` to start only four parallel
 307   jobs instead of by default the number of threads in the system.
 308
 309 Example Usages of CMake
 310 =======================
 311
 312 Typical Invocations
 313 -------------------
 314
 315 .. code-block:: console
 316
 317   $ cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ ..
 318   $ cmake -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++ ..
 319   $ cmake -DCMAKE_C_COMPILER=icc -DCMAKE_CXX_COMPILER=icpc ..
 320
 321 Advanced Builds with Various Options
 322 ------------------------------------
 323
 324 - Build the i386 Linux* library using GCC*
 325
 326   .. code-block:: console
 327
 328     $ cmake -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++ -DLIBOMP_ARCH=i386 ..
 329
 330 - Build the x86_64 debug Mac library using Clang*
 331
 332   .. code-block:: console
 333
 334     $ cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DLIBOMP_ARCH=x86_64 -DCMAKE_BUILD_TYPE=Debug ..
 335
 336 - Build the library (architecture determined by probing compiler) using the
 337   Intel(R) C Compiler and the Intel(R) C++ Compiler.  Also, create Fortran
 338   modules with the Intel(R) Fortran Compiler.
 339
 340   .. code-block:: console
 341
 342     $ cmake -DCMAKE_C_COMPILER=icc -DCMAKE_CXX_COMPILER=icpc -DCMAKE_Fortran_COMPILER=ifort -DLIBOMP_FORTRAN_MODULES=on ..
 343
 344 - Have CMake find the C/C++ compiler and specify additional flags for the
 345   preprocessor and C++ compiler.
 346
 347   .. code-blocks:: console
 348
 349     $ cmake -DLIBOMP_CPPFLAGS='-DNEW_FEATURE=1 -DOLD_FEATURE=0' -DLIBOMP_CXXFLAGS='--one-specific-flag --two-specific-flag' ..
 350
 351 - Build the stubs library
 352
 353   .. code-blocks:: console
 354
 355     $ cmake -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++ -DLIBOMP_LIB_TYPE=stubs ..
 356
 357 **Footnotes**
 358
 359 .. [*] Other names and brands may be claimed as the property of others.