1# -*- Python -*- 2 3# Configuration file for the 'lit' test runner. 4 5import os 6import sys 7import re 8import platform 9import subprocess 10 11import lit.util 12import lit.formats 13from lit.llvm import llvm_config 14from lit.llvm.subst import FindTool 15from lit.llvm.subst import ToolSubst 16 17# name: The name of this test suite. 18config.name = 'LLVM' 19 20# testFormat: The test format to use to interpret tests. 21config.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. 25config.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. 30config.excludes = ['Inputs', 'CMakeLists.txt', 'README.txt', 'LICENSE.txt'] 31 32# test_source_root: The root path where tests are located. 33config.test_source_root = os.path.dirname(__file__) 34 35# test_exec_root: The root path where tests should be run. 36config.test_exec_root = os.path.join(config.llvm_obj_root, 'test') 37 38# Tweak the PATH to include the tools dir. 39llvm_config.with_environment('PATH', config.llvm_tools_dir, append_path=True) 40 41# Propagate some variables from the host environment. 42llvm_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. 47top_ocaml_lib = os.path.join(config.llvm_lib_dir, 'ocaml') 48llvm_ocaml_lib = os.path.join(top_ocaml_lib, 'llvm') 49 50llvm_config.with_system_environment('OCAMLPATH') 51llvm_config.with_environment('OCAMLPATH', top_ocaml_lib, append_path=True) 52llvm_config.with_environment('OCAMLPATH', llvm_ocaml_lib, append_path=True) 53 54llvm_config.with_system_environment('CAML_LD_LIBRARY_PATH') 55llvm_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. 59llvm_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 65def 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 86llvm_config.use_default_substitutions() 87 88# Add site-specific substitutions. 89config.substitutions.append(('%llvmshlibdir', config.llvm_shlib_dir)) 90config.substitutions.append(('%shlibext', config.llvm_shlib_ext)) 91config.substitutions.append(('%exeext', config.llvm_exe_ext)) 92 93 94lli_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. 100if re.search(r'cygwin|windows-gnu|windows-msvc', config.host_triple): 101 lli_args = ['-mtriple=' + config.host_triple + '-elf'] 102 103llc_args = [] 104 105# Similarly, have a macro to use llc with DWARF even when the host is Windows 106if 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. 113ld64_cmd = config.ld64_executable 114asan_rtlib = get_asan_rtlib() 115if asan_rtlib: 116 ld64_cmd = 'DYLD_INSERT_LIBRARIES={} {}'.format(asan_rtlib, ld64_cmd) 117 118ocamlc_command = '%s ocamlc -cclib -L%s %s' % ( 119 config.ocamlfind_executable, config.llvm_lib_dir, config.ocaml_flags) 120ocamlopt_command = 'true' 121if 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 125opt_viewer_cmd = '%s %s/tools/opt-viewer/opt-viewer.py' % (sys.executable, config.llvm_src_root) 126 127llvm_locstats_tool = os.path.join(config.llvm_tools_dir, 'llvm-locstats') 128config.substitutions.append( 129 ('%llvm-locstats', "'%s' %s" % (config.python_executable, llvm_locstats_tool))) 130config.llvm_locstats_used = os.path.exists(llvm_locstats_tool) 131 132tools = [ 133 ToolSubst('%lli', FindTool('lli'), post='.', extra_args=lli_args), 134 ToolSubst('%llc_dwarf', FindTool('llc'), extra_args=llc_args), 135 ToolSubst('%go', config.go_executable, unresolved='ignore'), 136 ToolSubst('%gold', config.gold_executable, unresolved='ignore'), 137 ToolSubst('%ld64', ld64_cmd, unresolved='ignore'), 138 ToolSubst('%ocamlc', ocamlc_command, unresolved='ignore'), 139 ToolSubst('%ocamlopt', ocamlopt_command, unresolved='ignore'), 140 ToolSubst('%opt-viewer', opt_viewer_cmd), 141 ToolSubst('%llvm-objcopy', FindTool('llvm-objcopy')), 142 ToolSubst('%llvm-strip', FindTool('llvm-strip')), 143 ToolSubst('%llvm-install-name-tool', FindTool('llvm-install-name-tool')), 144] 145 146# FIXME: Why do we have both `lli` and `%lli` that do slightly different things? 147tools.extend([ 148 'dsymutil', 'lli', 'lli-child-target', 'llvm-ar', 'llvm-as', 149 'llvm-bcanalyzer', 'llvm-config', 'llvm-cov', 'llvm-cxxdump', 'llvm-cvtres', 150 'llvm-diff', 'llvm-dis', 'llvm-dwarfdump', 'llvm-exegesis', 'llvm-extract', 151 'llvm-isel-fuzzer', 'llvm-ifs', 'llvm-install-name-tool', 152 'llvm-jitlink', 'llvm-opt-fuzzer', 'llvm-lib', 153 'llvm-link', 'llvm-lto', 'llvm-lto2', 'llvm-mc', 'llvm-mca', 154 'llvm-modextract', 'llvm-nm', 'llvm-objcopy', 'llvm-objdump', 155 'llvm-pdbutil', 'llvm-profdata', 'llvm-ranlib', 'llvm-rc', 'llvm-readelf', 156 'llvm-readobj', 'llvm-rtdyld', 'llvm-size', 'llvm-split', 'llvm-strings', 157 'llvm-strip', 'llvm-tblgen', 'llvm-undname', 'llvm-c-test', 'llvm-cxxfilt', 158 'llvm-xray', 'yaml2obj', 'obj2yaml', 'yaml-bench', 'verify-uselistorder', 159 'bugpoint', 'llc', 'llvm-symbolizer', 'opt', 'sancov', 'sanstats']) 160 161# The following tools are optional 162tools.extend([ 163 ToolSubst('llvm-go', unresolved='ignore'), 164 ToolSubst('llvm-mt', unresolved='ignore'), 165 ToolSubst('Kaleidoscope-Ch3', unresolved='ignore'), 166 ToolSubst('Kaleidoscope-Ch4', unresolved='ignore'), 167 ToolSubst('Kaleidoscope-Ch5', unresolved='ignore'), 168 ToolSubst('Kaleidoscope-Ch6', unresolved='ignore'), 169 ToolSubst('Kaleidoscope-Ch7', unresolved='ignore'), 170 ToolSubst('Kaleidoscope-Ch8', unresolved='ignore')]) 171 172llvm_config.add_tool_substitutions(tools, config.llvm_tools_dir) 173 174# Targets 175 176config.targets = frozenset(config.targets_to_build.split()) 177 178for arch in config.targets_to_build.split(): 179 config.available_features.add(arch.lower() + '-registered-target') 180 181# Features 182known_arches = ["x86_64", "mips64", "ppc64", "aarch64"] 183if (config.host_ldflags.find("-m32") < 0 184 and any(config.llvm_host_triple.startswith(x) for x in known_arches)): 185 config.available_features.add("llvm-64-bits") 186 187config.available_features.add("host-byteorder-" + sys.byteorder + "-endian") 188 189if sys.platform in ['win32']: 190 # ExecutionEngine, no weak symbols in COFF. 191 config.available_features.add('uses_COFF') 192else: 193 # Others/can-execute.txt 194 config.available_features.add('can-execute') 195 196# Loadable module 197if config.has_plugins: 198 config.available_features.add('plugins') 199 200if config.build_examples: 201 config.available_features.add('examples') 202 203if config.linked_bye_extension: 204 config.substitutions.append(('%llvmcheckext', 'CHECK-EXT')) 205 config.substitutions.append(('%loadbye', '')) 206else: 207 config.substitutions.append(('%llvmcheckext', 'CHECK-NOEXT')) 208 config.substitutions.append(('%loadbye', 209 '-load={}/Bye{}'.format(config.llvm_shlib_dir, 210 config.llvm_shlib_ext))) 211 212# Static libraries are not built if BUILD_SHARED_LIBS is ON. 213if not config.build_shared_libs and not config.link_llvm_dylib: 214 config.available_features.add('static-libs') 215 216def have_cxx_shared_library(): 217 readobj_exe = lit.util.which('llvm-readobj', config.llvm_tools_dir) 218 if not readobj_exe: 219 print('llvm-readobj not found') 220 return False 221 222 try: 223 readobj_cmd = subprocess.Popen( 224 [readobj_exe, '-needed-libs', readobj_exe], stdout=subprocess.PIPE) 225 except OSError: 226 print('could not exec llvm-readobj') 227 return False 228 229 readobj_out = readobj_cmd.stdout.read().decode('ascii') 230 readobj_cmd.wait() 231 232 regex = re.compile(r'(libc\+\+|libstdc\+\+|msvcp).*\.(so|dylib|dll)') 233 needed_libs = False 234 for line in readobj_out.splitlines(): 235 if 'NeededLibraries [' in line: 236 needed_libs = True 237 if ']' in line: 238 needed_libs = False 239 if needed_libs and regex.search(line.lower()): 240 return True 241 return False 242 243if have_cxx_shared_library(): 244 config.available_features.add('cxx-shared-library') 245 246if config.libcxx_used: 247 config.available_features.add('libcxx-used') 248 249# Direct object generation 250if not 'hexagon' in config.target_triple: 251 config.available_features.add('object-emission') 252 253# LLVM can be configured with an empty default triple 254# Some tests are "generic" and require a valid default triple 255if config.target_triple: 256 config.available_features.add('default_triple') 257 258import subprocess 259 260 261def have_ld_plugin_support(): 262 if not os.path.exists(os.path.join(config.llvm_shlib_dir, 'LLVMgold' + config.llvm_shlib_ext)): 263 return False 264 265 ld_cmd = subprocess.Popen( 266 [config.gold_executable, '--help'], stdout=subprocess.PIPE, env={'LANG': 'C'}) 267 ld_out = ld_cmd.stdout.read().decode() 268 ld_cmd.wait() 269 270 if not '-plugin' in ld_out: 271 return False 272 273 # check that the used emulations are supported. 274 emu_line = [l for l in ld_out.split('\n') if 'supported emulations' in l] 275 if len(emu_line) != 1: 276 return False 277 emu_line = emu_line[0] 278 fields = emu_line.split(':') 279 if len(fields) != 3: 280 return False 281 emulations = fields[2].split() 282 if 'elf_x86_64' not in emulations: 283 return False 284 if 'elf32ppc' in emulations: 285 config.available_features.add('ld_emu_elf32ppc') 286 287 ld_version = subprocess.Popen( 288 [config.gold_executable, '--version'], stdout=subprocess.PIPE, env={'LANG': 'C'}) 289 if not 'GNU gold' in ld_version.stdout.read().decode(): 290 return False 291 ld_version.wait() 292 293 return True 294 295 296if have_ld_plugin_support(): 297 config.available_features.add('ld_plugin') 298 299 300def have_ld64_plugin_support(): 301 if not os.path.exists(os.path.join(config.llvm_shlib_dir, 'libLTO' + config.llvm_shlib_ext)): 302 return False 303 304 if config.ld64_executable == '': 305 return False 306 307 ld_cmd = subprocess.Popen( 308 [config.ld64_executable, '-v'], stderr=subprocess.PIPE) 309 ld_out = ld_cmd.stderr.read().decode() 310 ld_cmd.wait() 311 312 if 'ld64' not in ld_out or 'LTO' not in ld_out: 313 return False 314 315 return True 316 317 318if have_ld64_plugin_support(): 319 config.available_features.add('ld64_plugin') 320 321# Ask llvm-config about asserts and global-isel. 322llvm_config.feature_config( 323 [('--assertion-mode', {'ON': 'asserts'}), 324 ('--has-global-isel', {'ON': 'global-isel'})]) 325 326if 'darwin' == sys.platform: 327 try: 328 sysctl_cmd = subprocess.Popen(['sysctl', 'hw.optional.fma'], 329 stdout=subprocess.PIPE) 330 except OSError: 331 print('Could not exec sysctl') 332 result = sysctl_cmd.stdout.read().decode('ascii') 333 if -1 != result.find('hw.optional.fma: 1'): 334 config.available_features.add('fma3') 335 sysctl_cmd.wait() 336 337# .debug_frame is not emitted for targeting Windows x64. 338if not re.match(r'^x86_64.*-(windows-gnu|windows-msvc)', config.target_triple): 339 config.available_features.add('debug_frame') 340 341if config.have_libxar: 342 config.available_features.add('xar') 343 344if config.enable_threads: 345 config.available_features.add('thread_support') 346 347if config.llvm_libxml2_enabled: 348 config.available_features.add('libxml2') 349 350if config.have_opt_viewer_modules: 351 config.available_features.add('have_opt_viewer_modules') 352