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))
92config.substitutions.append(('%host_cc', config.host_cc))
93
94
95lli_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.
101if re.search(r'cygwin|mingw32|windows-gnu|windows-msvc|win32', config.host_triple):
102    lli_args = ['-mtriple=' + config.host_triple + '-elf']
103
104llc_args = []
105
106# Similarly, have a macro to use llc with DWARF even when the host is win32.
107if re.search(r'win32', config.target_triple):
108    llc_args = [' -mtriple=' +
109                config.target_triple.replace('-win32', '-mingw32')]
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.
114ld64_cmd = config.ld64_executable
115asan_rtlib = get_asan_rtlib()
116if asan_rtlib:
117    ld64_cmd = 'DYLD_INSERT_LIBRARIES={} {}'.format(asan_rtlib, ld64_cmd)
118
119ocamlc_command = '%s ocamlc -cclib -L%s %s' % (
120    config.ocamlfind_executable, config.llvm_lib_dir, config.ocaml_flags)
121ocamlopt_command = 'true'
122if config.have_ocamlopt:
123    ocamlopt_command = '%s ocamlopt -cclib -L%s -cclib -Wl,-rpath,%s %s' % (
124        config.ocamlfind_executable, config.llvm_lib_dir, config.llvm_lib_dir, config.ocaml_flags)
125
126opt_viewer_cmd = '%s %s/tools/opt-viewer/opt-viewer.py' % (sys.executable, config.llvm_src_root)
127
128tools = [
129    ToolSubst('%lli', FindTool('lli'), post='.', extra_args=lli_args),
130    ToolSubst('%llc_dwarf', FindTool('llc'), extra_args=llc_args),
131    ToolSubst('%go', config.go_executable, unresolved='ignore'),
132    ToolSubst('%gold', config.gold_executable, unresolved='ignore'),
133    ToolSubst('%ld64', ld64_cmd, unresolved='ignore'),
134    ToolSubst('%ocamlc', ocamlc_command, unresolved='ignore'),
135    ToolSubst('%ocamlopt', ocamlopt_command, unresolved='ignore'),
136    ToolSubst('%opt-viewer', opt_viewer_cmd),
137    ToolSubst('%llvm-objcopy', FindTool('llvm-objcopy')),
138    ToolSubst('%llvm-strip', FindTool('llvm-strip')),
139]
140
141# FIXME: Why do we have both `lli` and `%lli` that do slightly different things?
142tools.extend([
143    'dsymutil', 'lli', 'lli-child-target', 'llvm-ar', 'llvm-as', 'llvm-bcanalyzer',
144    'llvm-config', 'llvm-cov', 'llvm-cxxdump', 'llvm-cvtres', 'llvm-diff', 'llvm-dis',
145    'llvm-dwarfdump', 'llvm-extract', 'llvm-isel-fuzzer', '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-readobj',
149    'llvm-rtdyld', 'llvm-size', 'llvm-split', 'llvm-strings', 'llvm-strip', 'llvm-tblgen',
150    'llvm-undname', 'llvm-c-test', 'llvm-cxxfilt', 'llvm-xray', 'yaml2obj', 'obj2yaml',
151    'yaml-bench', 'verify-uselistorder',
152    'bugpoint', 'llc', 'llvm-symbolizer', 'opt', 'sancov', 'sanstats'])
153
154# The following tools are optional
155tools.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
165llvm_config.add_tool_substitutions(tools, config.llvm_tools_dir)
166
167# Targets
168
169config.targets = frozenset(config.targets_to_build.split())
170
171for arch in config.targets_to_build.split():
172    config.available_features.add(arch.lower() + '-registered-target')
173
174# Features
175known_arches = ["x86_64", "mips64", "ppc64", "aarch64"]
176if (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# Others/can-execute.txt
181if sys.platform not in ['win32']:
182    config.available_features.add('can-execute')
183    config.available_features.add('not_COFF')
184
185# Loadable module
186# FIXME: This should be supplied by Makefile or autoconf.
187if sys.platform in ['win32', 'cygwin']:
188    loadable_module = (config.enable_shared == 1)
189else:
190    loadable_module = True
191
192if loadable_module:
193    config.available_features.add('loadable_module')
194
195# Static libraries are not built if BUILD_SHARED_LIBS is ON.
196if not config.build_shared_libs and not config.link_llvm_dylib:
197    config.available_features.add('static-libs')
198
199def have_cxx_shared_library():
200    readobj_exe = lit.util.which('llvm-readobj', config.llvm_tools_dir)
201    if not readobj_exe:
202        print('llvm-readobj not found')
203        return False
204
205    try:
206        readobj_cmd = subprocess.Popen(
207            [readobj_exe, '-needed-libs', readobj_exe], stdout=subprocess.PIPE)
208    except OSError:
209        print('could not exec llvm-readobj')
210        return False
211
212    readobj_out = readobj_cmd.stdout.read().decode('ascii')
213    readobj_cmd.wait()
214
215    regex = re.compile(r'(libc\+\+|libstdc\+\+|msvcp).*\.(so|dylib|dll)')
216    needed_libs = False
217    for line in readobj_out.splitlines():
218        if 'NeededLibraries [' in line:
219            needed_libs = True
220        if ']' in line:
221            needed_libs = False
222        if needed_libs and regex.search(line.lower()):
223            return True
224    return False
225
226if have_cxx_shared_library():
227    config.available_features.add('cxx-shared-library')
228
229# Direct object generation
230if not 'hexagon' in config.target_triple:
231    config.available_features.add('object-emission')
232
233# LLVM can be configured with an empty default triple
234# Some tests are "generic" and require a valid default triple
235if config.target_triple:
236    config.available_features.add('default_triple')
237
238import subprocess
239
240
241def have_ld_plugin_support():
242    if not os.path.exists(os.path.join(config.llvm_shlib_dir, 'LLVMgold' + config.llvm_shlib_ext)):
243        return False
244
245    ld_cmd = subprocess.Popen(
246        [config.gold_executable, '--help'], stdout=subprocess.PIPE, env={'LANG': 'C'})
247    ld_out = ld_cmd.stdout.read().decode()
248    ld_cmd.wait()
249
250    if not '-plugin' in ld_out:
251        return False
252
253    # check that the used emulations are supported.
254    emu_line = [l for l in ld_out.split('\n') if 'supported emulations' in l]
255    if len(emu_line) != 1:
256        return False
257    emu_line = emu_line[0]
258    fields = emu_line.split(':')
259    if len(fields) != 3:
260        return False
261    emulations = fields[2].split()
262    if 'elf_x86_64' not in emulations:
263        return False
264    if 'elf32ppc' in emulations:
265        config.available_features.add('ld_emu_elf32ppc')
266
267    ld_version = subprocess.Popen(
268        [config.gold_executable, '--version'], stdout=subprocess.PIPE, env={'LANG': 'C'})
269    if not 'GNU gold' in ld_version.stdout.read().decode():
270        return False
271    ld_version.wait()
272
273    return True
274
275
276if have_ld_plugin_support():
277    config.available_features.add('ld_plugin')
278
279
280def have_ld64_plugin_support():
281    if not config.llvm_tool_lto_build or config.ld64_executable == '':
282        return False
283
284    ld_cmd = subprocess.Popen(
285        [config.ld64_executable, '-v'], stderr=subprocess.PIPE)
286    ld_out = ld_cmd.stderr.read().decode()
287    ld_cmd.wait()
288
289    if 'ld64' not in ld_out or 'LTO' not in ld_out:
290        return False
291
292    return True
293
294
295if have_ld64_plugin_support():
296    config.available_features.add('ld64_plugin')
297
298# Ask llvm-config about asserts and global-isel.
299llvm_config.feature_config(
300    [('--assertion-mode', {'ON': 'asserts'}),
301     ('--has-global-isel', {'ON': 'global-isel'})])
302
303if 'darwin' == sys.platform:
304    try:
305        sysctl_cmd = subprocess.Popen(['sysctl', 'hw.optional.fma'],
306                                      stdout=subprocess.PIPE)
307    except OSError:
308        print('Could not exec sysctl')
309    result = sysctl_cmd.stdout.read().decode('ascii')
310    if -1 != result.find('hw.optional.fma: 1'):
311        config.available_features.add('fma3')
312    sysctl_cmd.wait()
313
314# .debug_frame is not emitted for targeting Windows x64.
315if not re.match(r'^x86_64.*-(mingw32|windows-gnu|win32)', config.target_triple):
316    config.available_features.add('debug_frame')
317
318if config.have_libxar:
319    config.available_features.add('xar')
320
321if config.llvm_libxml2_enabled == '1':
322    config.available_features.add('libxml2')
323
324if config.have_opt_viewer_modules:
325    config.available_features.add('have_opt_viewer_modules')
326