llvm/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', '.test', '.txt', '.s', '.mir', '.yaml']
  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'])
  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(('%pluginext', config.llvm_plugin_ext))
  92 config.substitutions.append(('%exeext', config.llvm_exe_ext))
  93
  94
  95 lli_args = []
  96 # The target triple used by default by lli is the process target triple (some
  97 # triple appropriate for generating code for the current process) but because
  98 # we don't support COFF in MCJIT well enough for the tests, force ELF format on
  99 # Windows.  FIXME: the process target triple should be used here, but this is
 100 # difficult to obtain on Windows.
 101 if re.search(r'cygwin|windows-gnu|windows-msvc', config.host_triple):
 102     lli_args = ['-mtriple=' + config.host_triple + '-elf']
 103
 104 llc_args = []
 105
 106 # Similarly, have a macro to use llc with DWARF even when the host is Windows
 107 if re.search(r'windows-msvc', config.target_triple):
 108     llc_args = [' -mtriple=' +
 109                 config.target_triple.replace('-msvc', '-gnu')]
 110
 111 # Provide the path to asan runtime lib if available. On darwin, this lib needs
 112 # to be loaded via DYLD_INSERT_LIBRARIES before libLTO.dylib in case the files
 113 # to be linked contain instrumented sanitizer code.
 114 ld64_cmd = config.ld64_executable
 115 asan_rtlib = get_asan_rtlib()
 116 if asan_rtlib:
 117     ld64_cmd = 'DYLD_INSERT_LIBRARIES={} {}'.format(asan_rtlib, ld64_cmd)
 118 if config.osx_sysroot:
 119     ld64_cmd = '{} -syslibroot {}'.format(ld64_cmd, config.osx_sysroot)
 120
 121 ocamlc_command = '%s ocamlc -cclib -L%s %s' % (
 122     config.ocamlfind_executable, config.llvm_lib_dir, config.ocaml_flags)
 123 ocamlopt_command = 'true'
 124 if config.have_ocamlopt:
 125     ocamlopt_command = '%s ocamlopt -cclib -L%s -cclib -Wl,-rpath,%s %s' % (
 126         config.ocamlfind_executable, config.llvm_lib_dir, config.llvm_lib_dir, config.ocaml_flags)
 127
 128 opt_viewer_cmd = '%s %s/tools/opt-viewer/opt-viewer.py' % (sys.executable, config.llvm_src_root)
 129
 130 llvm_original_di_preservation_cmd = os.path.join(
 131     config.llvm_src_root,'utils', 'llvm-original-di-preservation.py')
 132 config.substitutions.append(
 133     ('%llvm-original-di-preservation', "'%s' %s" % (
 134         config.python_executable, llvm_original_di_preservation_cmd)))
 135
 136 llvm_locstats_tool = os.path.join(config.llvm_tools_dir, 'llvm-locstats')
 137 config.substitutions.append(
 138     ('%llvm-locstats', "'%s' %s" % (config.python_executable, llvm_locstats_tool)))
 139 config.llvm_locstats_used = os.path.exists(llvm_locstats_tool)
 140
 141 tools = [
 142     ToolSubst('%lli', FindTool('lli'), post='.', extra_args=lli_args),
 143     ToolSubst('%llc_dwarf', FindTool('llc'), extra_args=llc_args),
 144     ToolSubst('%go', config.go_executable, unresolved='ignore'),
 145     ToolSubst('%gold', config.gold_executable, unresolved='ignore'),
 146     ToolSubst('%ld64', ld64_cmd, unresolved='ignore'),
 147     ToolSubst('%ocamlc', ocamlc_command, unresolved='ignore'),
 148     ToolSubst('%ocamlopt', ocamlopt_command, unresolved='ignore'),
 149     ToolSubst('%opt-viewer', opt_viewer_cmd),
 150     ToolSubst('%llvm-objcopy', FindTool('llvm-objcopy')),
 151     ToolSubst('%llvm-strip', FindTool('llvm-strip')),
 152     ToolSubst('%llvm-install-name-tool', FindTool('llvm-install-name-tool')),
 153     ToolSubst('%llvm-bitcode-strip', FindTool('llvm-bitcode-strip')),
 154     ToolSubst('%split-file', FindTool('split-file')),
 155 ]
 156
 157 # FIXME: Why do we have both `lli` and `%lli` that do slightly different things?
 158 tools.extend([
 159     'dsymutil', 'lli', 'lli-child-target', 'llvm-ar', 'llvm-as',
 160     'llvm-addr2line', 'llvm-bcanalyzer', 'llvm-bitcode-strip', 'llvm-config',
 161     'llvm-cov', 'llvm-cxxdump', 'llvm-cvtres', 'llvm-debuginfod-find',
 162     'llvm-diff', 'llvm-dis', 'llvm-dwarfdump', 'llvm-dlltool', 'llvm-exegesis',
 163     'llvm-extract', 'llvm-isel-fuzzer', 'llvm-ifs',
 164     'llvm-install-name-tool', 'llvm-jitlink', 'llvm-opt-fuzzer', 'llvm-lib',
 165     'llvm-link', 'llvm-lto', 'llvm-lto2', 'llvm-mc', 'llvm-mca',
 166     'llvm-modextract', 'llvm-nm', 'llvm-objcopy', 'llvm-objdump', 'llvm-otool',
 167     'llvm-pdbutil', 'llvm-profdata', 'llvm-profgen', 'llvm-ranlib', 'llvm-rc', 'llvm-readelf',
 168     'llvm-readobj', 'llvm-remark-size-diff', 'llvm-rtdyld', 'llvm-sim',
 169     'llvm-size', 'llvm-split', 'llvm-stress', 'llvm-strings', 'llvm-strip',
 170     'llvm-tblgen', 'llvm-tapi-diff', 'llvm-undname', 'llvm-windres',
 171     'llvm-c-test', 'llvm-cxxfilt', 'llvm-xray', 'yaml2obj', 'obj2yaml',
 172     'yaml-bench', 'verify-uselistorder', 'bugpoint', 'llc', 'llvm-symbolizer',
 173     'opt', 'sancov', 'sanstats'])
 174
 175 # The following tools are optional
 176 tools.extend([
 177     ToolSubst('llvm-go', unresolved='ignore'),
 178     ToolSubst('llvm-mt', unresolved='ignore'),
 179     ToolSubst('Kaleidoscope-Ch3', unresolved='ignore'),
 180     ToolSubst('Kaleidoscope-Ch4', unresolved='ignore'),
 181     ToolSubst('Kaleidoscope-Ch5', unresolved='ignore'),
 182     ToolSubst('Kaleidoscope-Ch6', unresolved='ignore'),
 183     ToolSubst('Kaleidoscope-Ch7', unresolved='ignore'),
 184     ToolSubst('Kaleidoscope-Ch8', unresolved='ignore'),
 185     ToolSubst('LLJITWithThinLTOSummaries', unresolved='ignore'),
 186     ToolSubst('LLJITWithRemoteDebugging', unresolved='ignore'),
 187     ToolSubst('OrcV2CBindingsBasicUsage', unresolved='ignore'),
 188     ToolSubst('OrcV2CBindingsAddObjectFile', unresolved='ignore'),
 189     ToolSubst('OrcV2CBindingsRemovableCode', unresolved='ignore'),
 190     ToolSubst('OrcV2CBindingsReflectProcessSymbols', unresolved='ignore'),
 191     ToolSubst('OrcV2CBindingsLazy', unresolved='ignore'),
 192     ToolSubst('OrcV2CBindingsVeryLazy', unresolved='ignore'),
 193     ToolSubst('dxil-dis', unresolved='ignore')])
 194
 195 # Find (major, minor) version of ptxas
 196 def ptxas_version(ptxas):
 197     ptxas_cmd = subprocess.Popen([ptxas, '--version'], stdout=subprocess.PIPE)
 198     ptxas_out = ptxas_cmd.stdout.read().decode('ascii')
 199     ptxas_cmd.wait()
 200     match = re.search('release (\d+)\.(\d+)', ptxas_out)
 201     if match:
 202         return (int(match.group(1)), int(match.group(2)))
 203     print('couldn\'t determine ptxas version')
 204     return None
 205
 206 def enable_ptxas(ptxas_executable):
 207     version = ptxas_version(ptxas_executable)
 208     if version:
 209         # ptxas is supposed to be backward compatible with previous
 210         # versions, so add a feature for every known version prior to
 211         # the current one.
 212         ptxas_known_versions = [
 213             (9, 0), (9, 1), (9, 2),
 214             (10, 0), (10, 1), (10, 2),
 215             (11, 0), (11, 1), (11, 2), (11, 3), (11, 4), (11, 5), (11, 6),
 216         ]
 217
 218         # ignore ptxas if its version is below the minimum supported
 219         # version
 220         min_version = ptxas_known_versions[0]
 221         if version[0] < min_version[0] or version[1] < min_version[1]:
 222             print(
 223                 'Warning: ptxas version {}.{} is not supported'.format(
 224                     version[0], version[1]))
 225             return
 226
 227         for known_major, known_minor in ptxas_known_versions:
 228             if known_major <= version[0] and known_minor <= version[1]:
 229                 config.available_features.add(
 230                     'ptxas-{}.{}'.format(known_major, known_minor))
 231
 232     config.available_features.add('ptxas')
 233     tools.extend([ToolSubst('%ptxas', ptxas_executable),
 234                   ToolSubst('%ptxas-verify', '{} -c -o /dev/null -'.format(
 235                       ptxas_executable))])
 236
 237 ptxas_executable = \
 238     os.environ.get('LLVM_PTXAS_EXECUTABLE', None) or config.ptxas_executable
 239 if ptxas_executable:
 240     enable_ptxas(ptxas_executable)
 241
 242 llvm_config.add_tool_substitutions(tools, config.llvm_tools_dir)
 243
 244 # Targets
 245
 246 config.targets = frozenset(config.targets_to_build.split())
 247
 248 for arch in config.targets_to_build.split():
 249     config.available_features.add(arch.lower() + '-registered-target')
 250
 251 # Features
 252 known_arches = ["x86_64", "mips64", "ppc64", "aarch64"]
 253 if (config.host_ldflags.find("-m32") < 0
 254     and any(config.llvm_host_triple.startswith(x) for x in known_arches)):
 255   config.available_features.add("llvm-64-bits")
 256
 257 config.available_features.add("host-byteorder-" + sys.byteorder + "-endian")
 258
 259 if sys.platform in ['win32']:
 260     # ExecutionEngine, no weak symbols in COFF.
 261     config.available_features.add('uses_COFF')
 262 else:
 263     # Others/can-execute.txt
 264     config.available_features.add('can-execute')
 265
 266 # Loadable module
 267 if config.has_plugins:
 268     config.available_features.add('plugins')
 269
 270 if config.build_examples:
 271     config.available_features.add('examples')
 272
 273 if config.linked_bye_extension:
 274     config.substitutions.append(('%llvmcheckext', 'CHECK-EXT'))
 275     config.substitutions.append(('%loadbye', ''))
 276     config.substitutions.append(('%loadnewpmbye', ''))
 277 else:
 278     config.substitutions.append(('%llvmcheckext', 'CHECK-NOEXT'))
 279     config.substitutions.append(('%loadbye',
 280                                  '-load={}/Bye{}'.format(config.llvm_shlib_dir,
 281                                                          config.llvm_shlib_ext)))
 282     config.substitutions.append(('%loadnewpmbye',
 283                                  '-load-pass-plugin={}/Bye{}'
 284                                  .format(config.llvm_shlib_dir,
 285                                          config.llvm_shlib_ext)))
 286
 287
 288 # Static libraries are not built if BUILD_SHARED_LIBS is ON.
 289 if not config.build_shared_libs and not config.link_llvm_dylib:
 290     config.available_features.add('static-libs')
 291
 292 if config.link_llvm_dylib:
 293     config.available_features.add('llvm-dylib')
 294     config.substitutions.append(
 295         ('%llvmdylib',
 296          '{}/libLLVM-{}{}'.format(config.llvm_shlib_dir,
 297                                   config.llvm_dylib_version,
 298                                   config.llvm_shlib_ext)))
 299
 300 if config.have_tf_aot:
 301     config.available_features.add("have_tf_aot")
 302
 303 if config.have_tf_api:
 304     config.available_features.add("have_tf_api")
 305
 306 if config.llvm_inliner_model_autogenerated:
 307     config.available_features.add("llvm_inliner_model_autogenerated")
 308
 309 if config.llvm_raevict_model_autogenerated:
 310     config.available_features.add("llvm_raevict_model_autogenerated")
 311
 312 def have_cxx_shared_library():
 313     readobj_exe = lit.util.which('llvm-readobj', config.llvm_tools_dir)
 314     if not readobj_exe:
 315         print('llvm-readobj not found')
 316         return False
 317
 318     try:
 319         readobj_cmd = subprocess.Popen(
 320             [readobj_exe, '--needed-libs', readobj_exe], stdout=subprocess.PIPE)
 321     except OSError:
 322         print('could not exec llvm-readobj')
 323         return False
 324
 325     readobj_out = readobj_cmd.stdout.read().decode('ascii')
 326     readobj_cmd.wait()
 327
 328     regex = re.compile(r'(libc\+\+|libstdc\+\+|msvcp).*\.(so|dylib|dll)')
 329     needed_libs = False
 330     for line in readobj_out.splitlines():
 331         if 'NeededLibraries [' in line:
 332             needed_libs = True
 333         if ']' in line:
 334             needed_libs = False
 335         if needed_libs and regex.search(line.lower()):
 336             return True
 337     return False
 338
 339 if have_cxx_shared_library():
 340     config.available_features.add('cxx-shared-library')
 341
 342 if config.libcxx_used:
 343     config.available_features.add('libcxx-used')
 344
 345 # LLVM can be configured with an empty default triple
 346 # Some tests are "generic" and require a valid default triple
 347 if config.target_triple:
 348     config.available_features.add('default_triple')
 349     # Direct object generation
 350     if not config.target_triple.startswith(("nvptx", "xcore")):
 351         config.available_features.add('object-emission')
 352
 353 import subprocess
 354
 355
 356 def have_ld_plugin_support():
 357     if not os.path.exists(os.path.join(config.llvm_shlib_dir, 'LLVMgold' + config.llvm_shlib_ext)):
 358         return False
 359
 360     ld_cmd = subprocess.Popen(
 361         [config.gold_executable, '--help'], stdout=subprocess.PIPE, env={'LANG': 'C'})
 362     ld_out = ld_cmd.stdout.read().decode()
 363     ld_cmd.wait()
 364
 365     if not '-plugin' in ld_out:
 366         return False
 367
 368     # check that the used emulations are supported.
 369     emu_line = [l for l in ld_out.split('\n') if 'supported emulations' in l]
 370     if len(emu_line) != 1:
 371         return False
 372     emu_line = emu_line[0]
 373     fields = emu_line.split(':')
 374     if len(fields) != 3:
 375         return False
 376     emulations = fields[2].split()
 377     if 'elf_x86_64' not in emulations:
 378         return False
 379     if 'elf32ppc' in emulations:
 380         config.available_features.add('ld_emu_elf32ppc')
 381
 382     ld_version = subprocess.Popen(
 383         [config.gold_executable, '--version'], stdout=subprocess.PIPE, env={'LANG': 'C'})
 384     if not 'GNU gold' in ld_version.stdout.read().decode():
 385         return False
 386     ld_version.wait()
 387
 388     return True
 389
 390
 391 if have_ld_plugin_support():
 392     config.available_features.add('ld_plugin')
 393
 394
 395 def have_ld64_plugin_support():
 396     if not os.path.exists(os.path.join(config.llvm_shlib_dir, 'libLTO' + config.llvm_shlib_ext)):
 397         return False
 398
 399     if config.ld64_executable == '':
 400         return False
 401
 402     ld_cmd = subprocess.Popen(
 403         [config.ld64_executable, '-v'], stderr=subprocess.PIPE)
 404     ld_out = ld_cmd.stderr.read().decode()
 405     ld_cmd.wait()
 406
 407     if 'ld64' not in ld_out or 'LTO' not in ld_out:
 408         return False
 409
 410     return True
 411
 412
 413 if have_ld64_plugin_support():
 414     config.available_features.add('ld64_plugin')
 415
 416 # Ask llvm-config about asserts
 417 llvm_config.feature_config(
 418     [('--assertion-mode', {'ON': 'asserts'}),
 419      ('--build-mode', {'[Dd][Ee][Bb][Uu][Gg]': 'debug'})])
 420
 421 if 'darwin' == sys.platform:
 422     cmd = ['sysctl', 'hw.optional.fma']
 423     sysctl_cmd = subprocess.Popen(cmd, stdout=subprocess.PIPE)
 424
 425     # Non zero return, probably a permission issue
 426     if sysctl_cmd.wait():
 427         print(
 428           "Warning: sysctl exists but calling \"{}\" failed, defaulting to no fma3.".format(
 429           " ".join(cmd)))
 430     else:
 431         result = sysctl_cmd.stdout.read().decode('ascii')
 432         if 'hw.optional.fma: 1' in result:
 433             config.available_features.add('fma3')
 434
 435 # .debug_frame is not emitted for targeting Windows x64, arm64, or AIX.
 436 if not re.match(r'^(x86_64|arm64|powerpc|powerpc64).*-(windows-gnu|windows-msvc|aix)', config.target_triple):
 437     config.available_features.add('debug_frame')
 438
 439 if config.have_libxar:
 440     config.available_features.add('xar')
 441
 442 if config.enable_threads:
 443     config.available_features.add('thread_support')
 444
 445 if config.have_libxml2:
 446     config.available_features.add('libxml2')
 447
 448 if config.have_curl:
 449     config.available_features.add('curl')
 450
 451 if config.have_opt_viewer_modules:
 452     config.available_features.add('have_opt_viewer_modules')
 453
 454 if config.expensive_checks:
 455     config.available_features.add('expensive_checks')
 456
 457 if "MemoryWithOrigins" in config.llvm_use_sanitizer:
 458     config.available_features.add('use_msan_with_origins')
 459
 460 def exclude_unsupported_files_for_aix(dirname):
 461    for filename in os.listdir(dirname):
 462        source_path = os.path.join( dirname, filename)
 463        if os.path.isdir(source_path):
 464            continue
 465        f = open(source_path, 'r')
 466        try:
 467           data = f.read()
 468           # 64-bit object files are not supported on AIX, so exclude the tests.
 469           if ('-emit-obj' in data or '-filetype=obj' in data) and '64' in config.target_triple:
 470             config.excludes += [ filename ]
 471        finally:
 472           f.close()
 473
 474 if 'aix' in config.target_triple:
 475     for directory in ('/CodeGen/X86', '/DebugInfo', '/DebugInfo/X86', '/DebugInfo/Generic', '/LTO/X86', '/Linker'):
 476         exclude_unsupported_files_for_aix(config.test_source_root + directory)
 477