test/lit.cfg.py

   1 # -*- Python -*-
   2
   3 # Configuration file for the 'lit' test runner.
   4
   5 import os
   6 import sys
   7 import re
   8 import platform
   9 import subprocess
  10
  11 import lit.util
  12 import lit.formats
  13 from lit.llvm import llvm_config
  14 from lit.llvm.subst import FindTool
  15 from lit.llvm.subst import ToolSubst
  16
  17 # name: The name of this test suite.
  18 config.name = 'LLVM'
  19
  20 # testFormat: The test format to use to interpret tests.
  21 config.test_format = lit.formats.ShTest(not llvm_config.use_lit_shell)
  22
  23 # suffixes: A list of file extensions to treat as test files. This is overriden
  24 # by individual lit.local.cfg files in the test subdirectories.
  25 config.suffixes = ['.ll', '.c', '.cxx', '.test', '.txt', '.s', '.mir']
  26
  27 # excludes: A list of directories to exclude from the testsuite. The 'Inputs'
  28 # subdirectories contain auxiliary inputs for various tests in their parent
  29 # directories.
  30 config.excludes = ['Inputs', 'CMakeLists.txt', 'README.txt', 'LICENSE.txt']
  31
  32 # test_source_root: The root path where tests are located.
  33 config.test_source_root = os.path.dirname(__file__)
  34
  35 # test_exec_root: The root path where tests should be run.
  36 config.test_exec_root = os.path.join(config.llvm_obj_root, 'test')
  37
  38 # Tweak the PATH to include the tools dir.
  39 llvm_config.with_environment('PATH', config.llvm_tools_dir, append_path=True)
  40
  41 # Propagate some variables from the host environment.
  42 llvm_config.with_system_environment(
  43     ['HOME', 'INCLUDE', 'LIB', 'TMP', 'TEMP', 'ASAN_SYMBOLIZER_PATH', 'MSAN_SYMBOLIZER_PATH'])
  44
  45
  46 # Set up OCAMLPATH to include newly built OCaml libraries.
  47 top_ocaml_lib = os.path.join(config.llvm_lib_dir, 'ocaml')
  48 llvm_ocaml_lib = os.path.join(top_ocaml_lib, 'llvm')
  49
  50 llvm_config.with_system_environment('OCAMLPATH')
  51 llvm_config.with_environment('OCAMLPATH', top_ocaml_lib, append_path=True)
  52 llvm_config.with_environment('OCAMLPATH', llvm_ocaml_lib, append_path=True)
  53
  54 llvm_config.with_system_environment('CAML_LD_LIBRARY_PATH')
  55 llvm_config.with_environment(
  56     'CAML_LD_LIBRARY_PATH', llvm_ocaml_lib, append_path=True)
  57
  58 # Set up OCAMLRUNPARAM to enable backtraces in OCaml tests.
  59 llvm_config.with_environment('OCAMLRUNPARAM', 'b')
  60
  61 # Provide the path to asan runtime lib 'libclang_rt.asan_osx_dynamic.dylib' if
  62 # available. This is darwin specific since it's currently only needed on darwin.
  63
  64
  65 def get_asan_rtlib():
  66     if not 'Address' in config.llvm_use_sanitizer or \
  67        not 'Darwin' in config.host_os or \
  68        not 'x86' in config.host_triple:
  69         return ''
  70     try:
  71         import glob
  72     except:
  73         print('glob module not found, skipping get_asan_rtlib() lookup')
  74         return ''
  75     # The libclang_rt.asan_osx_dynamic.dylib path is obtained using the relative
  76     # path from the host cc.
  77     host_lib_dir = os.path.join(os.path.dirname(config.host_cc), '../lib')
  78     asan_dylib_dir_pattern = host_lib_dir + \
  79         '/clang/*/lib/darwin/libclang_rt.asan_osx_dynamic.dylib'
  80     found_dylibs = glob.glob(asan_dylib_dir_pattern)
  81     if len(found_dylibs) != 1:
  82         return ''
  83     return found_dylibs[0]
  84
  85
  86 llvm_config.use_default_substitutions()
  87
  88 # Add site-specific substitutions.
  89 config.substitutions.append(('%llvmshlibdir', config.llvm_shlib_dir))
  90 config.substitutions.append(('%shlibext', config.llvm_shlib_ext))
  91 config.substitutions.append(('%exeext', config.llvm_exe_ext))
  92
  93
  94 lli_args = []
  95 # The target triple used by default by lli is the process target triple (some
  96 # triple appropriate for generating code for the current process) but because
  97 # we don't support COFF in MCJIT well enough for the tests, force ELF format on
  98 # Windows.  FIXME: the process target triple should be used here, but this is
  99 # difficult to obtain on Windows.
 100 if re.search(r'cygwin|windows-gnu|windows-msvc', config.host_triple):
 101     lli_args = ['-mtriple=' + config.host_triple + '-elf']
 102
 103 llc_args = []
 104
 105 # Similarly, have a macro to use llc with DWARF even when the host is Windows
 106 if re.search(r'windows-msvc', config.target_triple):
 107     llc_args = [' -mtriple=' +
 108                 config.target_triple.replace('-msvc', '-gnu')]
 109
 110 # Provide the path to asan runtime lib if available. On darwin, this lib needs
 111 # to be loaded via DYLD_INSERT_LIBRARIES before libLTO.dylib in case the files
 112 # to be linked contain instrumented sanitizer code.
 113 ld64_cmd = config.ld64_executable
 114 asan_rtlib = get_asan_rtlib()
 115 if asan_rtlib:
 116     ld64_cmd = 'DYLD_INSERT_LIBRARIES={} {}'.format(asan_rtlib, ld64_cmd)
 117
 118 ocamlc_command = '%s ocamlc -cclib -L%s %s' % (
 119     config.ocamlfind_executable, config.llvm_lib_dir, config.ocaml_flags)
 120 ocamlopt_command = 'true'
 121 if config.have_ocamlopt:
 122     ocamlopt_command = '%s ocamlopt -cclib -L%s -cclib -Wl,-rpath,%s %s' % (
 123         config.ocamlfind_executable, config.llvm_lib_dir, config.llvm_lib_dir, config.ocaml_flags)
 124
 125 opt_viewer_cmd = '%s %s/tools/opt-viewer/opt-viewer.py' % (sys.executable, config.llvm_src_root)
 126
 127 tools = [
 128     ToolSubst('%lli', FindTool('lli'), post='.', extra_args=lli_args),
 129     ToolSubst('%llc_dwarf', FindTool('llc'), extra_args=llc_args),
 130     ToolSubst('%go', config.go_executable, unresolved='ignore'),
 131     ToolSubst('%gold', config.gold_executable, unresolved='ignore'),
 132     ToolSubst('%ld64', ld64_cmd, unresolved='ignore'),
 133     ToolSubst('%ocamlc', ocamlc_command, unresolved='ignore'),
 134     ToolSubst('%ocamlopt', ocamlopt_command, unresolved='ignore'),
 135     ToolSubst('%opt-viewer', opt_viewer_cmd),
 136     ToolSubst('%llvm-objcopy', FindTool('llvm-objcopy')),
 137     ToolSubst('%llvm-strip', FindTool('llvm-strip')),
 138 ]
 139
 140 # FIXME: Why do we have both `lli` and `%lli` that do slightly different things?
 141 tools.extend([
 142     'dsymutil', 'lli', 'lli-child-target', 'llvm-ar', 'llvm-as',
 143     'llvm-bcanalyzer', 'llvm-config', 'llvm-cov', 'llvm-cxxdump', 'llvm-cvtres',
 144     'llvm-diff', 'llvm-dis', 'llvm-dwarfdump', 'llvm-exegesis', 'llvm-extract',
 145     'llvm-isel-fuzzer', 'llvm-ifs', 'llvm-jitlink', 'llvm-opt-fuzzer', 'llvm-lib',
 146     'llvm-link', 'llvm-lto', 'llvm-lto2', 'llvm-mc', 'llvm-mca',
 147     'llvm-modextract', 'llvm-nm', 'llvm-objcopy', 'llvm-objdump',
 148     'llvm-pdbutil', 'llvm-profdata', 'llvm-ranlib', 'llvm-rc', 'llvm-readelf',
 149     'llvm-readobj', 'llvm-rtdyld', 'llvm-size', 'llvm-split', 'llvm-strings',
 150     'llvm-strip', 'llvm-tblgen', 'llvm-undname', 'llvm-c-test', 'llvm-cxxfilt',
 151     'llvm-xray', 'yaml2obj', 'obj2yaml', 'yaml-bench', 'verify-uselistorder',
 152     'bugpoint', 'llc', 'llvm-symbolizer', 'opt', 'sancov', 'sanstats'])
 153
 154 # The following tools are optional
 155 tools.extend([
 156     ToolSubst('llvm-go', unresolved='ignore'),
 157     ToolSubst('llvm-mt', unresolved='ignore'),
 158     ToolSubst('Kaleidoscope-Ch3', unresolved='ignore'),
 159     ToolSubst('Kaleidoscope-Ch4', unresolved='ignore'),
 160     ToolSubst('Kaleidoscope-Ch5', unresolved='ignore'),
 161     ToolSubst('Kaleidoscope-Ch6', unresolved='ignore'),
 162     ToolSubst('Kaleidoscope-Ch7', unresolved='ignore'),
 163     ToolSubst('Kaleidoscope-Ch8', unresolved='ignore')])
 164
 165 llvm_config.add_tool_substitutions(tools, config.llvm_tools_dir)
 166
 167 # Targets
 168
 169 config.targets = frozenset(config.targets_to_build.split())
 170
 171 for arch in config.targets_to_build.split():
 172     config.available_features.add(arch.lower() + '-registered-target')
 173
 174 # Features
 175 known_arches = ["x86_64", "mips64", "ppc64", "aarch64"]
 176 if (config.host_ldflags.find("-m32") < 0
 177     and any(config.llvm_host_triple.startswith(x) for x in known_arches)):
 178   config.available_features.add("llvm-64-bits")
 179
 180 config.available_features.add("host-byteorder-" + sys.byteorder + "-endian")
 181
 182 if sys.platform in ['win32']:
 183     # ExecutionEngine, no weak symbols in COFF.
 184     config.available_features.add('uses_COFF')
 185 else:
 186     # Others/can-execute.txt
 187     config.available_features.add('can-execute')
 188
 189 # Loadable module
 190 if config.has_plugins:
 191     config.available_features.add('plugins')
 192
 193 # Static libraries are not built if BUILD_SHARED_LIBS is ON.
 194 if not config.build_shared_libs and not config.link_llvm_dylib:
 195     config.available_features.add('static-libs')
 196
 197 def have_cxx_shared_library():
 198     readobj_exe = lit.util.which('llvm-readobj', config.llvm_tools_dir)
 199     if not readobj_exe:
 200         print('llvm-readobj not found')
 201         return False
 202
 203     try:
 204         readobj_cmd = subprocess.Popen(
 205             [readobj_exe, '-needed-libs', readobj_exe], stdout=subprocess.PIPE)
 206     except OSError:
 207         print('could not exec llvm-readobj')
 208         return False
 209
 210     readobj_out = readobj_cmd.stdout.read().decode('ascii')
 211     readobj_cmd.wait()
 212
 213     regex = re.compile(r'(libc\+\+|libstdc\+\+|msvcp).*\.(so|dylib|dll)')
 214     needed_libs = False
 215     for line in readobj_out.splitlines():
 216         if 'NeededLibraries [' in line:
 217             needed_libs = True
 218         if ']' in line:
 219             needed_libs = False
 220         if needed_libs and regex.search(line.lower()):
 221             return True
 222     return False
 223
 224 if have_cxx_shared_library():
 225     config.available_features.add('cxx-shared-library')
 226
 227 if config.libcxx_used:
 228     config.available_features.add('libcxx-used')
 229
 230 # Direct object generation
 231 if not 'hexagon' in config.target_triple:
 232     config.available_features.add('object-emission')
 233
 234 # LLVM can be configured with an empty default triple
 235 # Some tests are "generic" and require a valid default triple
 236 if config.target_triple:
 237     config.available_features.add('default_triple')
 238
 239 import subprocess
 240
 241
 242 def have_ld_plugin_support():
 243     if not os.path.exists(os.path.join(config.llvm_shlib_dir, 'LLVMgold' + config.llvm_shlib_ext)):
 244         return False
 245
 246     ld_cmd = subprocess.Popen(
 247         [config.gold_executable, '--help'], stdout=subprocess.PIPE, env={'LANG': 'C'})
 248     ld_out = ld_cmd.stdout.read().decode()
 249     ld_cmd.wait()
 250
 251     if not '-plugin' in ld_out:
 252         return False
 253
 254     # check that the used emulations are supported.
 255     emu_line = [l for l in ld_out.split('\n') if 'supported emulations' in l]
 256     if len(emu_line) != 1:
 257         return False
 258     emu_line = emu_line[0]
 259     fields = emu_line.split(':')
 260     if len(fields) != 3:
 261         return False
 262     emulations = fields[2].split()
 263     if 'elf_x86_64' not in emulations:
 264         return False
 265     if 'elf32ppc' in emulations:
 266         config.available_features.add('ld_emu_elf32ppc')
 267
 268     ld_version = subprocess.Popen(
 269         [config.gold_executable, '--version'], stdout=subprocess.PIPE, env={'LANG': 'C'})
 270     if not 'GNU gold' in ld_version.stdout.read().decode():
 271         return False
 272     ld_version.wait()
 273
 274     return True
 275
 276
 277 if have_ld_plugin_support():
 278     config.available_features.add('ld_plugin')
 279
 280
 281 def have_ld64_plugin_support():
 282     if not os.path.exists(os.path.join(config.llvm_shlib_dir, 'libLTO' + config.llvm_shlib_ext)):
 283         return False
 284
 285     if config.ld64_executable == '':
 286         return False
 287
 288     ld_cmd = subprocess.Popen(
 289         [config.ld64_executable, '-v'], stderr=subprocess.PIPE)
 290     ld_out = ld_cmd.stderr.read().decode()
 291     ld_cmd.wait()
 292
 293     if 'ld64' not in ld_out or 'LTO' not in ld_out:
 294         return False
 295
 296     return True
 297
 298
 299 if have_ld64_plugin_support():
 300     config.available_features.add('ld64_plugin')
 301
 302 # Ask llvm-config about asserts and global-isel.
 303 llvm_config.feature_config(
 304     [('--assertion-mode', {'ON': 'asserts'}),
 305      ('--has-global-isel', {'ON': 'global-isel'})])
 306
 307 if 'darwin' == sys.platform:
 308     try:
 309         sysctl_cmd = subprocess.Popen(['sysctl', 'hw.optional.fma'],
 310                                       stdout=subprocess.PIPE)
 311     except OSError:
 312         print('Could not exec sysctl')
 313     result = sysctl_cmd.stdout.read().decode('ascii')
 314     if -1 != result.find('hw.optional.fma: 1'):
 315         config.available_features.add('fma3')
 316     sysctl_cmd.wait()
 317
 318 # .debug_frame is not emitted for targeting Windows x64.
 319 if not re.match(r'^x86_64.*-(windows-gnu|windows-msvc)', config.target_triple):
 320     config.available_features.add('debug_frame')
 321
 322 if config.have_libxar:
 323     config.available_features.add('xar')
 324
 325 if config.enable_threads:
 326     config.available_features.add('thread_support')
 327
 328 if config.llvm_libxml2_enabled:
 329     config.available_features.add('libxml2')
 330
 331 if config.have_opt_viewer_modules:
 332     config.available_features.add('have_opt_viewer_modules')