flang/docs/FortranLLVMTestSuite.md

   1 # Fortran Tests in the LLVM Test Suite
   2
   3 ```eval_rst
   4 .. contents::
   5    :local:
   6 ```
   7
   8 The [LLVM Test Suite](https://github.com/llvm/llvm-test-suite) is a
   9 separate git repo from the main LLVM project. We recommend that
  10 first-time users read through [LLVM Test Suite
  11 Guide](https://llvm.org/docs/TestSuiteGuide.html) which describes the
  12 organizational structure of the test suite and how to run it.
  13
  14 Although the Flang driver is unable to generate code at this time, we
  15 are neverthelesss incrementally adding Fortran tests into the LLVM
  16 Test Suite. We are currently testing against GFortran while we make
  17 progress towards completing the new Flang driver with full
  18 code-generation capabilities.
  19
  20 ## Running the LLVM test-suite with Fortran
  21
  22 Fortran support can be enabled by setting the following CMake variables:
  23 ```
  24 cmake -G "Ninja" -DCMAKE_C_COMPILER=<path to C compiler> \
  25     -DCMAKE_CXX_COMPILER=<path to C++ compiler> \
  26     -DCMAKE_Fortran_COMPILER=<path to Fortran compiler> \
  27     -DTEST_SUITE_COLLECT_CODE_SIZE:STRING=OFF \
  28     -DTEST_SUITE_SUBDIRS:STRING="Fortran" \
  29     -DTEST_SUITE_FORTRAN:STRING=ON ..
  30 ```
  31
  32 This will configure the test-suite to run only the Fortran tests which
  33 are found in the Fortran subdirectory. To run the C/C++ tests
  34 alongside the Fortran tests omit the `-DTEST_SUITE_SUBDIRS` CMake
  35 variable.
  36
  37 If your Fortran compiler is Flang, you may want to set the `NO_STOP_MESSAGE`
  38 environment variable to `1` in order to avoid test failures due to warnings
  39 about INEXACT signaling exceptions.
  40
  41
  42 ## Running the SPEC CPU 2017
  43
  44 We recently added CMake hooks into the LLVM Test Suite to support
  45 Fortran tests from [SPEC CPU 2017](https://www.spec.org/cpu2017/). We
  46 strongly encourage the use of the CMake Ninja (1.10 or later) generator
  47 due to better support for Fortran module dependency detection. Some of
  48 the SPEC CPU 2017 Fortran tests, those that are derived from climate
  49 codes, require support for little-endian/big-endian byte swapping
  50 capabilities which we automatically detect at CMake configuration
  51 time.  Note that a copy of SPEC CPU 2017 must be purchased by your
  52 home institution and is not provided by LLVM.
  53
  54
  55 Here is an example of how to build SPEC CPU 2017 with GCC
  56
  57 ```
  58 cmake -G "Ninja" -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++ \
  59     -DCMAKE_Fortran_COMPILER=gfortran \
  60     -DTEST_SUITE_COLLECT_CODE_SIZE:STRING=OFF \
  61     -DTEST_SUITE_SUBDIRS:STRING="External/SPEC" \
  62     -DTEST_SUITE_FORTRAN:STRING=ON \
  63     -DTEST_SUITE_SPEC2017_ROOT=<path to SPEC directory>  ..
  64 ```