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', '.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.
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    ToolSubst('%llvm-bitcode-strip', FindTool('llvm-bitcode-strip')),
145    ToolSubst('%split-file', FindTool('split-file')),
146]
147
148# FIXME: Why do we have both `lli` and `%lli` that do slightly different things?
149tools.extend([
150    'dsymutil', 'lli', 'lli-child-target', 'llvm-ar', 'llvm-as',
151    'llvm-addr2line', 'llvm-bcanalyzer', 'llvm-bitcode-strip', 'llvm-config',
152    'llvm-cov', 'llvm-cxxdump', 'llvm-cvtres', 'llvm-diff', 'llvm-dis',
153    'llvm-dwarfdump', 'llvm-dlltool', 'llvm-exegesis', 'llvm-extract',
154    'llvm-isel-fuzzer', 'llvm-ifs',
155    'llvm-install-name-tool', 'llvm-jitlink', 'llvm-opt-fuzzer', 'llvm-lib',
156    'llvm-link', 'llvm-lto', 'llvm-lto2', 'llvm-mc', 'llvm-mca',
157    'llvm-modextract', 'llvm-nm', 'llvm-objcopy', 'llvm-objdump',
158    'llvm-pdbutil', 'llvm-profdata', 'llvm-ranlib', 'llvm-rc', 'llvm-readelf',
159    'llvm-readobj', 'llvm-rtdyld', 'llvm-size', 'llvm-split', 'llvm-strings',
160    'llvm-strip', 'llvm-tblgen', 'llvm-undname', 'llvm-c-test', 'llvm-cxxfilt',
161    'llvm-xray', 'yaml2obj', 'obj2yaml', 'yaml-bench', 'verify-uselistorder',
162    'bugpoint', 'llc', 'llvm-symbolizer', 'opt', 'sancov', 'sanstats'])
163
164# The following tools are optional
165tools.extend([
166    ToolSubst('llvm-go', unresolved='ignore'),
167    ToolSubst('llvm-mt', unresolved='ignore'),
168    ToolSubst('Kaleidoscope-Ch3', unresolved='ignore'),
169    ToolSubst('Kaleidoscope-Ch4', unresolved='ignore'),
170    ToolSubst('Kaleidoscope-Ch5', unresolved='ignore'),
171    ToolSubst('Kaleidoscope-Ch6', unresolved='ignore'),
172    ToolSubst('Kaleidoscope-Ch7', unresolved='ignore'),
173    ToolSubst('Kaleidoscope-Ch8', unresolved='ignore'),
174    ToolSubst('LLJITWithThinLTOSummaries', unresolved='ignore')])
175
176llvm_config.add_tool_substitutions(tools, config.llvm_tools_dir)
177
178# Targets
179
180config.targets = frozenset(config.targets_to_build.split())
181
182for arch in config.targets_to_build.split():
183    config.available_features.add(arch.lower() + '-registered-target')
184
185# Features
186known_arches = ["x86_64", "mips64", "ppc64", "aarch64"]
187if (config.host_ldflags.find("-m32") < 0
188    and any(config.llvm_host_triple.startswith(x) for x in known_arches)):
189  config.available_features.add("llvm-64-bits")
190
191config.available_features.add("host-byteorder-" + sys.byteorder + "-endian")
192
193if sys.platform in ['win32']:
194    # ExecutionEngine, no weak symbols in COFF.
195    config.available_features.add('uses_COFF')
196else:
197    # Others/can-execute.txt
198    config.available_features.add('can-execute')
199
200# Loadable module
201if config.has_plugins:
202    config.available_features.add('plugins')
203
204if config.build_examples:
205    config.available_features.add('examples')
206
207if config.linked_bye_extension:
208    config.substitutions.append(('%llvmcheckext', 'CHECK-EXT'))
209    config.substitutions.append(('%loadbye', ''))
210    config.substitutions.append(('%loadnewpmbye', ''))
211else:
212    config.substitutions.append(('%llvmcheckext', 'CHECK-NOEXT'))
213    config.substitutions.append(('%loadbye',
214                                 '-load={}/Bye{}'.format(config.llvm_shlib_dir,
215                                                         config.llvm_shlib_ext)))
216    config.substitutions.append(('%loadnewpmbye',
217                                 '-load-pass-plugin={}/Bye{}'
218                                 .format(config.llvm_shlib_dir,
219                                         config.llvm_shlib_ext)))
220
221
222# Static libraries are not built if BUILD_SHARED_LIBS is ON.
223if not config.build_shared_libs and not config.link_llvm_dylib:
224    config.available_features.add('static-libs')
225
226if config.have_tf_aot:
227    config.available_features.add("have_tf_aot")
228
229if config.have_tf_api:
230    config.available_features.add("have_tf_api")
231
232def have_cxx_shared_library():
233    readobj_exe = lit.util.which('llvm-readobj', config.llvm_tools_dir)
234    if not readobj_exe:
235        print('llvm-readobj not found')
236        return False
237
238    try:
239        readobj_cmd = subprocess.Popen(
240            [readobj_exe, '-needed-libs', readobj_exe], stdout=subprocess.PIPE)
241    except OSError:
242        print('could not exec llvm-readobj')
243        return False
244
245    readobj_out = readobj_cmd.stdout.read().decode('ascii')
246    readobj_cmd.wait()
247
248    regex = re.compile(r'(libc\+\+|libstdc\+\+|msvcp).*\.(so|dylib|dll)')
249    needed_libs = False
250    for line in readobj_out.splitlines():
251        if 'NeededLibraries [' in line:
252            needed_libs = True
253        if ']' in line:
254            needed_libs = False
255        if needed_libs and regex.search(line.lower()):
256            return True
257    return False
258
259if have_cxx_shared_library():
260    config.available_features.add('cxx-shared-library')
261
262if config.libcxx_used:
263    config.available_features.add('libcxx-used')
264
265# LLVM can be configured with an empty default triple
266# Some tests are "generic" and require a valid default triple
267if config.target_triple:
268    config.available_features.add('default_triple')
269
270import subprocess
271
272
273def have_ld_plugin_support():
274    if not os.path.exists(os.path.join(config.llvm_shlib_dir, 'LLVMgold' + config.llvm_shlib_ext)):
275        return False
276
277    ld_cmd = subprocess.Popen(
278        [config.gold_executable, '--help'], stdout=subprocess.PIPE, env={'LANG': 'C'})
279    ld_out = ld_cmd.stdout.read().decode()
280    ld_cmd.wait()
281
282    if not '-plugin' in ld_out:
283        return False
284
285    # check that the used emulations are supported.
286    emu_line = [l for l in ld_out.split('\n') if 'supported emulations' in l]
287    if len(emu_line) != 1:
288        return False
289    emu_line = emu_line[0]
290    fields = emu_line.split(':')
291    if len(fields) != 3:
292        return False
293    emulations = fields[2].split()
294    if 'elf_x86_64' not in emulations:
295        return False
296    if 'elf32ppc' in emulations:
297        config.available_features.add('ld_emu_elf32ppc')
298
299    ld_version = subprocess.Popen(
300        [config.gold_executable, '--version'], stdout=subprocess.PIPE, env={'LANG': 'C'})
301    if not 'GNU gold' in ld_version.stdout.read().decode():
302        return False
303    ld_version.wait()
304
305    return True
306
307
308if have_ld_plugin_support():
309    config.available_features.add('ld_plugin')
310
311
312def have_ld64_plugin_support():
313    if not os.path.exists(os.path.join(config.llvm_shlib_dir, 'libLTO' + config.llvm_shlib_ext)):
314        return False
315
316    if config.ld64_executable == '':
317        return False
318
319    ld_cmd = subprocess.Popen(
320        [config.ld64_executable, '-v'], stderr=subprocess.PIPE)
321    ld_out = ld_cmd.stderr.read().decode()
322    ld_cmd.wait()
323
324    if 'ld64' not in ld_out or 'LTO' not in ld_out:
325        return False
326
327    return True
328
329
330if have_ld64_plugin_support():
331    config.available_features.add('ld64_plugin')
332
333# Ask llvm-config about asserts
334llvm_config.feature_config(
335    [('--assertion-mode', {'ON': 'asserts'}),
336     ('--build-mode', {'[Dd][Ee][Bb][Uu][Gg]': 'debug'})])
337
338if 'darwin' == sys.platform:
339    cmd = ['sysctl', 'hw.optional.fma']
340    sysctl_cmd = subprocess.Popen(cmd, stdout=subprocess.PIPE)
341
342    # Non zero return, probably a permission issue
343    if sysctl_cmd.wait():
344        print(
345          "Warning: sysctl exists but calling \"{}\" failed, defaulting to no fma3.".format(
346          " ".join(cmd)))
347    else:
348        result = sysctl_cmd.stdout.read().decode('ascii')
349        if 'hw.optional.fma: 1' in result:
350            config.available_features.add('fma3')
351
352# .debug_frame is not emitted for targeting Windows x64.
353if not re.match(r'^x86_64.*-(windows-gnu|windows-msvc)', config.target_triple):
354    config.available_features.add('debug_frame')
355
356if config.have_libxar:
357    config.available_features.add('xar')
358
359if config.enable_threads:
360    config.available_features.add('thread_support')
361
362if config.have_libxml2:
363    config.available_features.add('libxml2')
364
365if config.have_opt_viewer_modules:
366    config.available_features.add('have_opt_viewer_modules')
367
368if config.expensive_checks:
369    config.available_features.add('expensive_checks')
370