Prune the feature "tls". No one is using it since TLS is enabled for Cygwin.
[oota-llvm.git] / test / lit.cfg
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
10 import lit.util
11 import lit.formats
12
13 # name: The name of this test suite.
14 config.name = 'LLVM'
15
16 # Tweak PATH for Win32 to decide to use bash.exe or not.
17 if sys.platform in ['win32']:
18     # Seek sane tools in directories and set to $PATH.
19     path = getattr(config, 'lit_tools_dir', None)
20     path = lit_config.getToolsPath(path,
21                                    config.environment['PATH'],
22                                    ['cmp.exe', 'grep.exe', 'sed.exe'])
23     if path is not None:
24         path = os.path.pathsep.join((path,
25                                      config.environment['PATH']))
26         config.environment['PATH'] = path
27
28 # Choose between lit's internal shell pipeline runner and a real shell.  If
29 # LIT_USE_INTERNAL_SHELL is in the environment, we use that as an override.
30 use_lit_shell = os.environ.get("LIT_USE_INTERNAL_SHELL")
31 if use_lit_shell:
32     # 0 is external, "" is default, and everything else is internal.
33     execute_external = (use_lit_shell == "0")
34 else:
35     # Otherwise we default to internal on Windows and external elsewhere, as
36     # bash on Windows is usually very slow.
37     execute_external = (not sys.platform in ['win32'])
38
39 # testFormat: The test format to use to interpret tests.
40 config.test_format = lit.formats.ShTest(execute_external)
41
42 # suffixes: A list of file extensions to treat as test files. This is overriden
43 # by individual lit.local.cfg files in the test subdirectories.
44 config.suffixes = ['.ll', '.c', '.cxx', '.test', '.txt', '.s']
45
46 # excludes: A list of directories to exclude from the testsuite. The 'Inputs'
47 # subdirectories contain auxiliary inputs for various tests in their parent
48 # directories.
49 config.excludes = ['Inputs', 'CMakeLists.txt', 'README.txt', 'LICENSE.txt']
50
51 # test_source_root: The root path where tests are located.
52 config.test_source_root = os.path.dirname(__file__)
53
54 # test_exec_root: The root path where tests should be run.
55 llvm_obj_root = getattr(config, 'llvm_obj_root', None)
56 if llvm_obj_root is not None:
57     config.test_exec_root = os.path.join(llvm_obj_root, 'test')
58
59 # Tweak the PATH to include the tools dir.
60 if llvm_obj_root is not None:
61     llvm_tools_dir = getattr(config, 'llvm_tools_dir', None)
62     if not llvm_tools_dir:
63         lit_config.fatal('No LLVM tools dir set!')
64     path = os.path.pathsep.join((llvm_tools_dir, config.environment['PATH']))
65     config.environment['PATH'] = path
66
67 # Propagate 'HOME' through the environment.
68 if 'HOME' in os.environ:
69     config.environment['HOME'] = os.environ['HOME']
70
71 # Propagate 'INCLUDE' through the environment.
72 if 'INCLUDE' in os.environ:
73     config.environment['INCLUDE'] = os.environ['INCLUDE']
74
75 # Propagate 'LIB' through the environment.
76 if 'LIB' in os.environ:
77     config.environment['LIB'] = os.environ['LIB']
78
79 # Propagate the temp directory. Windows requires this because it uses \Windows\
80 # if none of these are present.
81 if 'TMP' in os.environ:
82     config.environment['TMP'] = os.environ['TMP']
83 if 'TEMP' in os.environ:
84     config.environment['TEMP'] = os.environ['TEMP']
85
86 # Propagate LLVM_SRC_ROOT into the environment.
87 config.environment['LLVM_SRC_ROOT'] = getattr(config, 'llvm_src_root', '')
88
89 # Propagate PYTHON_EXECUTABLE into the environment
90 config.environment['PYTHON_EXECUTABLE'] = getattr(config, 'python_executable',
91                                                   '')
92
93 # Propagate path to symbolizer for ASan/MSan.
94 for symbolizer in ['ASAN_SYMBOLIZER_PATH', 'MSAN_SYMBOLIZER_PATH']:
95     if symbolizer in os.environ:
96         config.environment[symbolizer] = os.environ[symbolizer]
97
98 # Set up OCAMLPATH to include newly built OCaml libraries.
99 llvm_lib_dir = getattr(config, 'llvm_lib_dir', None)
100 if llvm_lib_dir is None:
101     if llvm_obj_root is not None:
102         llvm_lib_dir = os.path.join(llvm_obj_root, 'lib')
103
104 if llvm_lib_dir is not None:
105     llvm_ocaml_lib = os.path.join(llvm_lib_dir, 'ocaml')
106     if llvm_ocaml_lib is not None:
107         if 'OCAMLPATH' in os.environ:
108             ocamlpath = os.path.pathsep.join((llvm_ocaml_lib, os.environ['OCAMLPATH']))
109             config.environment['OCAMLPATH'] = ocamlpath
110         else:
111             config.environment['OCAMLPATH'] = llvm_ocaml_lib
112
113         if 'CAML_LD_LIBRARY_PATH' in os.environ:
114             caml_ld_library_path = os.path.pathsep.join((llvm_ocaml_lib,
115                                         os.environ['CAML_LD_LIBRARY_PATH']))
116             config.environment['CAML_LD_LIBRARY_PATH'] = caml_ld_library_path
117         else:
118             config.environment['CAML_LD_LIBRARY_PATH'] = llvm_ocaml_lib
119
120 # Set up OCAMLRUNPARAM to enable backtraces in OCaml tests.
121 config.environment['OCAMLRUNPARAM'] = 'b'
122
123 ###
124
125 import os
126
127 # Check that the object root is known.
128 if config.test_exec_root is None:
129     # Otherwise, we haven't loaded the site specific configuration (the user is
130     # probably trying to run on a test file directly, and either the site
131     # configuration hasn't been created by the build system, or we are in an
132     # out-of-tree build situation).
133
134     # Check for 'llvm_site_config' user parameter, and use that if available.
135     site_cfg = lit_config.params.get('llvm_site_config', None)
136     if site_cfg and os.path.exists(site_cfg):
137         lit_config.load_config(config, site_cfg)
138         raise SystemExit
139
140     # Try to detect the situation where we are using an out-of-tree build by
141     # looking for 'llvm-config'.
142     #
143     # FIXME: I debated (i.e., wrote and threw away) adding logic to
144     # automagically generate the lit.site.cfg if we are in some kind of fresh
145     # build situation. This means knowing how to invoke the build system
146     # though, and I decided it was too much magic.
147
148     llvm_config = lit.util.which('llvm-config', config.environment['PATH'])
149     if not llvm_config:
150         lit_config.fatal('No site specific configuration available!')
151
152     # Get the source and object roots.
153     llvm_src_root = lit.util.capture(['llvm-config', '--src-root']).strip()
154     llvm_obj_root = lit.util.capture(['llvm-config', '--obj-root']).strip()
155
156     # Validate that we got a tree which points to here.
157     this_src_root = os.path.dirname(config.test_source_root)
158     if os.path.realpath(llvm_src_root) != os.path.realpath(this_src_root):
159         lit_config.fatal('No site specific configuration available!')
160
161     # Check that the site specific configuration exists.
162     site_cfg = os.path.join(llvm_obj_root, 'test', 'lit.site.cfg')
163     if not os.path.exists(site_cfg):
164         lit_config.fatal('No site specific configuration available!')
165
166     # Okay, that worked. Notify the user of the automagic, and reconfigure.
167     lit_config.note('using out-of-tree build at %r' % llvm_obj_root)
168     lit_config.load_config(config, site_cfg)
169     raise SystemExit
170
171 ###
172
173 lli = 'lli'
174 # The target triple used by default by lli is the process target triple (some
175 # triple appropriate for generating code for the current process) but because
176 # we don't support COFF in MCJIT well enough for the tests, force ELF format on
177 # Windows.  FIXME: the process target triple should be used here, but this is
178 # difficult to obtain on Windows.
179 if re.search(r'cygwin|mingw32|windows-gnu|windows-msvc|win32', config.host_triple):
180   lli += ' -mtriple='+config.host_triple+'-elf'
181 config.substitutions.append( ('%lli', lli ) )
182
183 # Similarly, have a macro to use llc with DWARF even when the host is win32.
184 llc_dwarf = 'llc'
185 if re.search(r'win32', config.target_triple):
186   llc_dwarf += ' -mtriple='+config.target_triple.replace('-win32', '-mingw32')
187 config.substitutions.append( ('%llc_dwarf', llc_dwarf) )
188
189 # Add site-specific substitutions.
190 config.substitutions.append( ('%gold', config.gold_executable) )
191 config.substitutions.append( ('%ld64', config.ld64_executable) )
192 config.substitutions.append( ('%go', config.go_executable) )
193 config.substitutions.append( ('%llvmshlibdir', config.llvm_shlib_dir) )
194 config.substitutions.append( ('%shlibext', config.llvm_shlib_ext) )
195 config.substitutions.append( ('%exeext', config.llvm_exe_ext) )
196 config.substitutions.append( ('%python', config.python_executable) )
197
198 # OCaml substitutions.
199 # Support tests for both native and bytecode builds.
200 config.substitutions.append( ('%ocamlc',
201     "%s ocamlc -cclib -L%s %s" %
202         (config.ocamlfind_executable, llvm_lib_dir, config.ocaml_flags)) )
203 if config.have_ocamlopt in ('1', 'TRUE'):
204     config.substitutions.append( ('%ocamlopt',
205         "%s ocamlopt -cclib -L%s -cclib -Wl,-rpath,%s %s" %
206             (config.ocamlfind_executable, llvm_lib_dir, llvm_lib_dir, config.ocaml_flags)) )
207 else:
208     config.substitutions.append( ('%ocamlopt', "true" ) )
209
210 # For each occurrence of an llvm tool name as its own word, replace it
211 # with the full path to the build directory holding that tool.  This
212 # ensures that we are testing the tools just built and not some random
213 # tools that might happen to be in the user's PATH.  Thus this list
214 # includes every tool placed in $(LLVM_OBJ_ROOT)/$(BuildMode)/bin
215 # (llvm_tools_dir in lit parlance).
216
217 # Avoid matching RUN line fragments that are actually part of
218 # path names or options or whatever.
219 # The regex is a pre-assertion to avoid matching a preceding
220 # dot, hyphen, carat, or slash (.foo, -foo, etc.).  Some patterns
221 # also have a post-assertion to not match a trailing hyphen (foo-).
222 NOJUNK = r"(?<!\.|-|\^|/)"
223
224
225 def find_tool_substitution(pattern):
226     # Extract the tool name from the pattern.  This relies on the tool
227     # name being surrounded by \b word match operators.  If the
228     # pattern starts with "| ", include it in the string to be
229     # substituted.
230     tool_match = re.match(r"^(\\)?((\| )?)\W+b([0-9A-Za-z-_]+)\\b\W*$",
231                           pattern)
232     tool_pipe = tool_match.group(2)
233     tool_name = tool_match.group(4)
234     # Did the user specify the tool path + arguments? This allows things like
235     # llvm-lit "-Dllc=llc -enable-misched -verify-machineinstrs"
236     tool_path = lit_config.params.get(tool_name)
237     if tool_path is None:
238         tool_path = lit.util.which(tool_name, llvm_tools_dir)
239         if tool_path is None:
240             return tool_name, tool_path, tool_pipe
241     if (tool_name == "llc" and
242        'LLVM_ENABLE_MACHINE_VERIFIER' in os.environ and
243        os.environ['LLVM_ENABLE_MACHINE_VERIFIER'] == "1"):
244         tool_path += " -verify-machineinstrs"
245     if (tool_name == "llvm-go"):
246         tool_path += " go=" + config.go_executable
247     return tool_name, tool_path, tool_pipe
248
249
250 for pattern in [r"\bbugpoint\b(?!-)",
251                 NOJUNK + r"\bllc\b",
252                 r"\blli\b",
253                 r"\bllvm-ar\b",
254                 r"\bllvm-as\b",
255                 r"\bllvm-bcanalyzer\b",
256                 r"\bllvm-config\b",
257                 r"\bllvm-cov\b",
258                 r"\bllvm-cxxdump\b",
259                 r"\bllvm-diff\b",
260                 r"\bllvm-dis\b",
261                 r"\bllvm-dsymutil\b",
262                 r"\bllvm-dwarfdump\b",
263                 r"\bllvm-extract\b",
264                 r"\bllvm-lib\b",
265                 r"\bllvm-link\b",
266                 r"\bllvm-lto\b",
267                 r"\bllvm-mc\b",
268                 r"\bllvm-mcmarkup\b",
269                 r"\bllvm-nm\b",
270                 r"\bllvm-objdump\b",
271                 r"\bllvm-profdata\b",
272                 r"\bllvm-ranlib\b",
273                 r"\bllvm-readobj\b",
274                 r"\bllvm-rtdyld\b",
275                 r"\bllvm-size\b",
276                 r"\bllvm-split\b",
277                 r"\bllvm-tblgen\b",
278                 r"\bllvm-c-test\b",
279                 NOJUNK + r"\bopt\b",
280                 r"\bFileCheck\b",
281                 r"\bobj2yaml\b",
282                 NOJUNK + r"\bsancov\b",
283                 r"\byaml2obj\b",
284                 r"\byaml-bench\b",
285                 r"\bverify-uselistorder\b",
286                 # Handle these specially as they are strings searched
287                 # for during testing.
288                 r"\| \bcount\b",
289                 r"\| \bnot\b"]:
290     tool_name, tool_path, tool_pipe = find_tool_substitution(pattern)
291     if not tool_path:
292         # Warn, but still provide a substitution.
293         lit_config.note('Did not find ' + tool_name + ' in ' + llvm_tools_dir)
294         tool_path = llvm_tools_dir + '/' + tool_name
295     config.substitutions.append((pattern, tool_pipe + tool_path))
296
297 # For tools that are optional depending on the config, we won't warn
298 # if they're missing.
299 for pattern in [r"\bllvm-go\b",
300                 r"\bKaleidoscope-Ch3\b",
301                 r"\bKaleidoscope-Ch4\b",
302                 r"\bKaleidoscope-Ch5\b",
303                 r"\bKaleidoscope-Ch6\b",
304                 r"\bKaleidoscope-Ch7\b",
305                 r"\bKaleidoscope-Ch8\b"]:
306     tool_name, tool_path, tool_pipe = find_tool_substitution(pattern)
307     if not tool_path:
308         # Provide a substitution anyway, for the sake of consistent errors.
309         tool_path = llvm_tools_dir + '/' + tool_name
310     config.substitutions.append((pattern, tool_pipe + tool_path))
311
312
313 ### Targets
314
315 config.targets = frozenset(config.targets_to_build.split())
316
317 ### Features
318
319 # Shell execution
320 if execute_external:
321     config.available_features.add('shell')
322
323 # Others/can-execute.txt
324 if sys.platform not in ['win32']:
325     config.available_features.add('can-execute')
326
327 # Loadable module
328 # FIXME: This should be supplied by Makefile or autoconf.
329 if sys.platform in ['win32', 'cygwin']:
330     loadable_module = (config.enable_shared == 1)
331 else:
332     loadable_module = True
333
334 if loadable_module:
335     config.available_features.add('loadable_module')
336
337 # Sanitizers.
338 if config.llvm_use_sanitizer == "Address":
339     config.available_features.add("asan")
340 if (config.llvm_use_sanitizer == "Memory" or
341         config.llvm_use_sanitizer == "MemoryWithOrigins"):
342     config.available_features.add("msan")
343 else:
344     config.available_features.add("not_msan")
345 if config.llvm_use_sanitizer == "Undefined":
346     config.available_features.add("ubsan")
347 else:
348     config.available_features.add("not_ubsan")
349
350 # Check if we should run long running tests.
351 if lit_config.params.get("run_long_tests", None) == "true":
352     config.available_features.add("long_tests")
353
354 # Direct object generation
355 if not 'hexagon' in config.target_triple:
356     config.available_features.add("object-emission")
357
358 if config.have_zlib == "1":
359     config.available_features.add("zlib")
360 else:
361     config.available_features.add("nozlib")
362
363 # LLVM can be configured with an empty default triple
364 # Some tests are "generic" and require a valid default triple
365 if config.target_triple:
366     config.available_features.add("default_triple")
367     if re.match(r'^x86_64.*-linux', config.target_triple):
368       config.available_features.add("x86_64-linux")
369
370 # Native compilation: host arch == default triple arch
371 # FIXME: Consider cases that target can be executed
372 # even if host_triple were different from target_triple.
373 if config.host_triple == config.target_triple:
374     config.available_features.add("native")
375
376 import subprocess
377
378 def have_ld_plugin_support():
379     if not os.path.exists(os.path.join(config.llvm_shlib_dir, 'LLVMgold.so')):
380         return False
381
382     ld_cmd = subprocess.Popen([config.gold_executable, '--help'], stdout = subprocess.PIPE, env={'LANG': 'C'})
383     ld_out = ld_cmd.stdout.read().decode()
384     ld_cmd.wait()
385
386     if not '-plugin' in ld_out:
387         return False
388
389     # check that the used emulations are supported.
390     emu_line = [l for l in ld_out.split('\n') if 'supported emulations' in l]
391     if len(emu_line) != 1:
392         return False
393     emu_line = emu_line[0]
394     fields = emu_line.split(':')
395     if len(fields) != 3:
396         return False
397     emulations = fields[2].split()
398     if 'elf_x86_64' not in emulations:
399         return False
400     if 'elf32ppc' in emulations:
401         config.available_features.add('ld_emu_elf32ppc')
402
403     ld_version = subprocess.Popen([config.gold_executable, '--version'], stdout = subprocess.PIPE, env={'LANG': 'C'})
404     if not 'GNU gold' in ld_version.stdout.read().decode():
405         return False
406     ld_version.wait()
407
408     return True
409
410 if have_ld_plugin_support():
411     config.available_features.add('ld_plugin')
412
413 def have_ld64_plugin_support():
414     if config.ld64_executable == '':
415         return False
416
417     ld_cmd = subprocess.Popen([config.ld64_executable, '-v'], stderr = subprocess.PIPE)
418     ld_out = ld_cmd.stderr.read().decode()
419     ld_cmd.wait()
420
421     if 'ld64' not in ld_out or 'LTO' not in ld_out:
422         return False
423
424     return True
425
426 if have_ld64_plugin_support():
427     config.available_features.add('ld64_plugin')
428
429 # Ask llvm-config about assertion mode.
430 try:
431     llvm_config_cmd = subprocess.Popen(
432         [os.path.join(llvm_tools_dir, 'llvm-config'), '--assertion-mode'],
433         stdout = subprocess.PIPE,
434         env=config.environment)
435 except OSError:
436     print("Could not find llvm-config in " + llvm_tools_dir)
437     exit(42)
438
439 if re.search(r'ON', llvm_config_cmd.stdout.read().decode('ascii')):
440     config.available_features.add('asserts')
441 llvm_config_cmd.wait()
442
443 if 'darwin' == sys.platform:
444     try:
445         sysctl_cmd = subprocess.Popen(['sysctl', 'hw.optional.fma'],
446                                     stdout = subprocess.PIPE)
447     except OSError:
448         print("Could not exec sysctl")
449     result = sysctl_cmd.stdout.read().decode('ascii')
450     if -1 != result.find("hw.optional.fma: 1"):
451         config.available_features.add('fma3')
452     sysctl_cmd.wait()
453
454 if platform.system() in ['Windows'] and re.match(r'.*-win32$', config.target_triple):
455     # For tests that require Windows to run.
456     config.available_features.add('system-windows')
457
458 # .debug_frame is not emitted for targeting Windows x64.
459 if not re.match(r'^x86_64.*-(mingw32|windows-gnu|win32)', config.target_triple):
460     config.available_features.add('debug_frame')
461
462 # Check if we are embedding timestamps.
463 if config.enable_timestamps == '1':
464     config.available_features.add('timestamps')
465
466 # Check if we should use gmalloc.
467 use_gmalloc_str = lit_config.params.get('use_gmalloc', None)
468 if use_gmalloc_str is not None:
469     if use_gmalloc_str.lower() in ('1', 'true'):
470         use_gmalloc = True
471     elif use_gmalloc_str.lower() in ('', '0', 'false'):
472         use_gmalloc = False
473     else:
474         lit_config.fatal('user parameter use_gmalloc should be 0 or 1')
475 else:
476     # Default to not using gmalloc
477     use_gmalloc = False
478
479 # Allow use of an explicit path for gmalloc library.
480 # Will default to '/usr/lib/libgmalloc.dylib' if not set.
481 gmalloc_path_str = lit_config.params.get('gmalloc_path',
482                                          '/usr/lib/libgmalloc.dylib')
483
484 if use_gmalloc:
485      config.environment.update({'DYLD_INSERT_LIBRARIES' : gmalloc_path_str})