[X86] Cleanup ADCX/ADOX instruction definitions.
[lldb.git] / 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', '.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 config.substitutions.append(('%host_cc', config.host_cc))
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|mingw32|windows-gnu|windows-msvc|win32', 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 win32.
107 if 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.
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
119 ocamlc_command = '%s ocamlc -cclib -L%s %s' % (
120     config.ocamlfind_executable, config.llvm_lib_dir, config.ocaml_flags)
121 ocamlopt_command = 'true'
122 if 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
126 opt_viewer_cmd = '%s %s/tools/opt-viewer/opt-viewer.py' % (sys.executable, config.llvm_src_root)
127
128 tools = [
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 ]
138
139 # FIXME: Why do we have both `lli` and `%lli` that do slightly different things?
140 tools.extend([
141     'dsymutil', 'lli', 'lli-child-target', 'llvm-ar', 'llvm-as', 'llvm-bcanalyzer',
142     'llvm-config', 'llvm-cov', 'llvm-cxxdump', 'llvm-cvtres', 'llvm-diff', 'llvm-dis',
143     'llvm-dwarfdump', 'llvm-extract', 'llvm-isel-fuzzer', 'llvm-opt-fuzzer', 'llvm-lib',
144     'llvm-link', 'llvm-lto', 'llvm-lto2', 'llvm-mc', 'llvm-mca','llvm-mcmarkup',
145     'llvm-modextract', 'llvm-nm', 'llvm-objcopy', 'llvm-objdump',
146     'llvm-pdbutil', 'llvm-profdata', 'llvm-ranlib', 'llvm-readobj',
147     'llvm-rtdyld', 'llvm-size', 'llvm-split', 'llvm-strings', 'llvm-tblgen',
148     'llvm-c-test', 'llvm-cxxfilt', 'llvm-xray', 'yaml2obj', 'obj2yaml',
149     'yaml-bench', 'verify-uselistorder',
150     'bugpoint', 'llc', 'llvm-symbolizer', 'opt', 'sancov', 'sanstats'])
151
152 # The following tools are optional
153 tools.extend([
154     ToolSubst('llvm-go', unresolved='ignore'),
155     ToolSubst('llvm-mt', unresolved='ignore'),
156     ToolSubst('Kaleidoscope-Ch3', unresolved='ignore'),
157     ToolSubst('Kaleidoscope-Ch4', unresolved='ignore'),
158     ToolSubst('Kaleidoscope-Ch5', unresolved='ignore'),
159     ToolSubst('Kaleidoscope-Ch6', unresolved='ignore'),
160     ToolSubst('Kaleidoscope-Ch7', unresolved='ignore'),
161     ToolSubst('Kaleidoscope-Ch8', unresolved='ignore')])
162
163 llvm_config.add_tool_substitutions(tools, config.llvm_tools_dir)
164
165 # Targets
166
167 config.targets = frozenset(config.targets_to_build.split())
168
169 for arch in config.targets_to_build.split():
170     config.available_features.add(arch.lower() + '-registered-target')
171
172 # Features
173 known_arches = ["x86_64", "mips64", "ppc64", "aarch64"]
174 if (config.host_ldflags.find("-m32") < 0
175     and any(config.llvm_host_triple.startswith(x) for x in known_arches)):
176   config.available_features.add("llvm-64-bits")
177
178 # Others/can-execute.txt
179 if sys.platform not in ['win32']:
180     config.available_features.add('can-execute')
181     config.available_features.add('not_COFF')
182
183 # Loadable module
184 # FIXME: This should be supplied by Makefile or autoconf.
185 if sys.platform in ['win32', 'cygwin']:
186     loadable_module = (config.enable_shared == 1)
187 else:
188     loadable_module = True
189
190 if loadable_module:
191     config.available_features.add('loadable_module')
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 # Direct object generation
228 if not 'hexagon' in config.target_triple:
229     config.available_features.add('object-emission')
230
231 # LLVM can be configured with an empty default triple
232 # Some tests are "generic" and require a valid default triple
233 if config.target_triple:
234     config.available_features.add('default_triple')
235
236 import subprocess
237
238
239 def have_ld_plugin_support():
240     if not os.path.exists(os.path.join(config.llvm_shlib_dir, 'LLVMgold.so')):
241         return False
242
243     ld_cmd = subprocess.Popen(
244         [config.gold_executable, '--help'], stdout=subprocess.PIPE, env={'LANG': 'C'})
245     ld_out = ld_cmd.stdout.read().decode()
246     ld_cmd.wait()
247
248     if not '-plugin' in ld_out:
249         return False
250
251     # check that the used emulations are supported.
252     emu_line = [l for l in ld_out.split('\n') if 'supported emulations' in l]
253     if len(emu_line) != 1:
254         return False
255     emu_line = emu_line[0]
256     fields = emu_line.split(':')
257     if len(fields) != 3:
258         return False
259     emulations = fields[2].split()
260     if 'elf_x86_64' not in emulations:
261         return False
262     if 'elf32ppc' in emulations:
263         config.available_features.add('ld_emu_elf32ppc')
264
265     ld_version = subprocess.Popen(
266         [config.gold_executable, '--version'], stdout=subprocess.PIPE, env={'LANG': 'C'})
267     if not 'GNU gold' in ld_version.stdout.read().decode():
268         return False
269     ld_version.wait()
270
271     return True
272
273
274 if have_ld_plugin_support():
275     config.available_features.add('ld_plugin')
276
277
278 def have_ld64_plugin_support():
279     if not config.llvm_tool_lto_build or config.ld64_executable == '':
280         return False
281
282     ld_cmd = subprocess.Popen(
283         [config.ld64_executable, '-v'], stderr=subprocess.PIPE)
284     ld_out = ld_cmd.stderr.read().decode()
285     ld_cmd.wait()
286
287     if 'ld64' not in ld_out or 'LTO' not in ld_out:
288         return False
289
290     return True
291
292
293 if have_ld64_plugin_support():
294     config.available_features.add('ld64_plugin')
295
296 # Ask llvm-config about asserts and global-isel.
297 llvm_config.feature_config(
298     [('--assertion-mode', {'ON': 'asserts'}),
299      ('--has-global-isel', {'ON': 'global-isel'})])
300
301 if 'darwin' == sys.platform:
302     try:
303         sysctl_cmd = subprocess.Popen(['sysctl', 'hw.optional.fma'],
304                                       stdout=subprocess.PIPE)
305     except OSError:
306         print('Could not exec sysctl')
307     result = sysctl_cmd.stdout.read().decode('ascii')
308     if -1 != result.find('hw.optional.fma: 1'):
309         config.available_features.add('fma3')
310     sysctl_cmd.wait()
311
312 # .debug_frame is not emitted for targeting Windows x64.
313 if not re.match(r'^x86_64.*-(mingw32|windows-gnu|win32)', config.target_triple):
314     config.available_features.add('debug_frame')
315
316 if config.have_libxar:
317     config.available_features.add('xar')
318
319 if config.llvm_libxml2_enabled == '1':
320     config.available_features.add('libxml2')
321
322 if config.have_opt_viewer_modules:
323     config.available_features.add('have_opt_viewer_modules')