68 lines · plain
1========================================2Compiler-rt Testing Infrastructure Guide3========================================4 5.. contents::6 :local:7 8Overview9========10 11This document is the reference manual for the compiler-rt modifications to the12testing infrastructure. Documentation for the infrastructure itself can be found at13:ref:`llvm_testing_guide`.14 15LLVM testing infrastructure organization16========================================17 18The compiler-rt testing infrastructure contains regression tests which are run19as part of the usual ``make check-all`` and are expected to always pass -- they20should be run before every commit.21 22Quick start23===========24 25The regressions tests are in the "compiler-rt" module and are normally checked26out in the directory ``llvm/projects/compiler-rt/test``. Use ``make check-all``27to run the regression tests after building compiler-rt.28 29REQUIRES, XFAIL, etc.30---------------------31 32Sometimes it is necessary to restrict a test to a specific target or mark it as33an "expected fail" or XFAIL. This is normally achieved using ``REQUIRES:`` or34``XFAIL:`` and the ``target=<target-triple>`` feature, typically with a regular35expression matching an appropriate substring of the triple. Unfortunately, the36behaviour of this is somewhat quirky in compiler-rt. There are two main37pitfalls to avoid.38 39The first pitfall is that these regular expressions may inadvertently match40more triples than expected. For example, ``XFAIL: target=mips{{.*}}`` matches41``mips-linux-gnu``, ``mipsel-linux-gnu``, ``mips64-linux-gnu``, and42``mips64el-linux-gnu``. Including a trailing ``-`` such as in 43``XFAIL: target=mips-{{.*}}`` can help to mitigate this quirk but even that has44issues as described below.45 46The second pitfall is that the default target triple is often inappropriate for47compiler-rt tests since compiler-rt tests may be compiled for multiple targets.48For example, a typical build on an ``x86_64-linux-gnu`` host will often run the49tests for both x86_64 and i386. In this situation ``XFAIL: target=x86_64{{{.*}}``50will mark both the x86_64 and i386 tests as an expected failure while 51``XFAIL: target=i386{{.*}}`` will have no effect at all.52 53To remedy both pitfalls, compiler-rt tests provide a feature string which can54be used to specify a single target. This string is of the form55``target-is-${arch}`` where ``${arch}}`` is one of the values from the56following lines of the CMake output::57 58 -- Compiler-RT supported architectures: x86_64;i38659 -- Builtin supported architectures: i386;x86_6460 61So for example ``XFAIL: target-is-x86_64`` will mark a test as expected to fail62on x86_64 without also affecting the i386 test and ``XFAIL: target-is-i386``63will mark a test as expected to fail on i386 even if the default target triple64is ``x86_64-linux-gnu``. Directives that use these ``target-is-${arch}`` string65require exact matches so ``XFAIL: target-is-mips``,66``XFAIL: target-is-mipsel``, ``XFAIL: target-is-mips64``, and67``XFAIL: target-is-mips64el`` all refer to different MIPS targets.68