Fix Twine corruption problem with diagnostics.
[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', '.cpp', '.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 # Propagate options for sanitizers.
99 for options in ['ASAN_OPTIONS', 'UBSAN_OPTIONS']:
100     if options in os.environ:
101         config.environment[options] = os.environ[options]
102
103 # Set up OCAMLPATH to include newly built OCaml libraries.
104 llvm_ocaml_lib = os.path.join(getattr(config, 'llvm_lib_dir', None), 'ocaml')
105 if 'OCAMLPATH' in os.environ:
106     ocamlpath = os.path.pathsep.join((llvm_ocaml_lib, os.environ['OCAMLPATH']))
107     config.environment['OCAMLPATH'] = ocamlpath
108 else:
109     config.environment['OCAMLPATH'] = llvm_ocaml_lib
110
111 # Set up OCAMLRUNPARAM to enable backtraces in OCaml tests.
112 config.environment['OCAMLRUNPARAM'] = 'b'
113
114 ###
115
116 import os
117
118 # Check that the object root is known.
119 if config.test_exec_root is None:
120     # Otherwise, we haven't loaded the site specific configuration (the user is
121     # probably trying to run on a test file directly, and either the site
122     # configuration hasn't been created by the build system, or we are in an
123     # out-of-tree build situation).
124
125     # Check for 'llvm_site_config' user parameter, and use that if available.
126     site_cfg = lit_config.params.get('llvm_site_config', None)
127     if site_cfg and os.path.exists(site_cfg):
128         lit_config.load_config(config, site_cfg)
129         raise SystemExit
130
131     # Try to detect the situation where we are using an out-of-tree build by
132     # looking for 'llvm-config'.
133     #
134     # FIXME: I debated (i.e., wrote and threw away) adding logic to
135     # automagically generate the lit.site.cfg if we are in some kind of fresh
136     # build situation. This means knowing how to invoke the build system
137     # though, and I decided it was too much magic.
138
139     llvm_config = lit.util.which('llvm-config', config.environment['PATH'])
140     if not llvm_config:
141         lit_config.fatal('No site specific configuration available!')
142
143     # Get the source and object roots.
144     llvm_src_root = lit.util.capture(['llvm-config', '--src-root']).strip()
145     llvm_obj_root = lit.util.capture(['llvm-config', '--obj-root']).strip()
146
147     # Validate that we got a tree which points to here.
148     this_src_root = os.path.dirname(config.test_source_root)
149     if os.path.realpath(llvm_src_root) != os.path.realpath(this_src_root):
150         lit_config.fatal('No site specific configuration available!')
151
152     # Check that the site specific configuration exists.
153     site_cfg = os.path.join(llvm_obj_root, 'test', 'lit.site.cfg')
154     if not os.path.exists(site_cfg):
155         lit_config.fatal('No site specific configuration available!')
156
157     # Okay, that worked. Notify the user of the automagic, and reconfigure.
158     lit_config.note('using out-of-tree build at %r' % llvm_obj_root)
159     lit_config.load_config(config, site_cfg)
160     raise SystemExit
161
162 ###
163
164 lli = 'lli'
165 # The target triple used by default by lli is the process target triple (some
166 # triple appropriate for generating code for the current process) but because
167 # we don't support COFF in MCJIT well enough for the tests, force ELF format on
168 # Windows.  FIXME: the process target triple should be used here, but this is
169 # difficult to obtain on Windows.
170 if re.search(r'cygwin|mingw32|win32', config.host_triple):
171   lli += ' -mtriple='+config.host_triple+'-elf'
172 config.substitutions.append( ('%lli', lli ) )
173
174 # Similarly, have a macro to use llc with DWARF even when the host is win32.
175 llc_dwarf = 'llc'
176 if re.search(r'win32', config.target_triple):
177   llc_dwarf += ' -mtriple='+config.target_triple.replace('-win32', '-mingw32')
178 config.substitutions.append( ('%llc_dwarf', llc_dwarf) )
179
180 # Add site-specific substitutions.
181 config.substitutions.append( ('%go', config.go_executable) )
182 config.substitutions.append( ('%llvmshlibdir', config.llvm_shlib_dir) )
183 config.substitutions.append( ('%shlibext', config.llvm_shlib_ext) )
184 config.substitutions.append( ('%exeext', config.llvm_exe_ext) )
185 config.substitutions.append( ('%python', config.python_executable) )
186
187 # OCaml substitutions.
188 # Support tests for both native and bytecode builds.
189 if config.have_ocamlopt == '1':
190     config.substitutions.append( ('%ocamlcomp',
191         "%s ocamlopt %s" % (config.ocamlfind_executable, config.ocaml_flags)) )
192 else:
193     config.substitutions.append( ('%ocamlcomp',
194         "%s ocamlc %s" % (config.ocamlfind_executable, config.ocaml_flags)) )
195
196 # For each occurrence of an llvm tool name as its own word, replace it
197 # with the full path to the build directory holding that tool.  This
198 # ensures that we are testing the tools just built and not some random
199 # tools that might happen to be in the user's PATH.  Thus this list
200 # includes every tool placed in $(LLVM_OBJ_ROOT)/$(BuildMode)/bin
201 # (llvm_tools_dir in lit parlance).
202
203 # Avoid matching RUN line fragments that are actually part of
204 # path names or options or whatever.
205 # The regex is a pre-assertion to avoid matching a preceding
206 # dot, hyphen, carat, or slash (.foo, -foo, etc.).  Some patterns
207 # also have a post-assertion to not match a trailing hyphen (foo-).
208 NOJUNK = r"(?<!\.|-|\^|/)"
209
210 for pattern in [r"\bbugpoint\b(?!-)",
211                 NOJUNK + r"\bllc\b",
212                 r"\blli\b",
213                 r"\bllvm-ar\b",
214                 r"\bllvm-as\b",
215                 r"\bllvm-bcanalyzer\b",
216                 r"\bllvm-config\b",
217                 r"\bllvm-cov\b",
218                 r"\bllvm-diff\b",
219                 r"\bllvm-dis\b",
220                 r"\bllvm-dwarfdump\b",
221                 r"\bllvm-extract\b",
222                 r"\bllvm-go\b",
223                 r"\bllvm-link\b",
224                 r"\bllvm-lto\b",
225                 r"\bllvm-mc\b",
226                 r"\bllvm-mcmarkup\b",
227                 r"\bllvm-nm\b",
228                 r"\bllvm-objdump\b",
229                 r"\bllvm-profdata\b",
230                 r"\bllvm-ranlib\b",
231                 r"\bllvm-readobj\b",
232                 r"\bllvm-rtdyld\b",
233                 r"\bllvm-size\b",
234                 r"\bllvm-tblgen\b",
235                 r"\bllvm-vtabledump\b",
236                 r"\bllvm-c-test\b",
237                 r"\bmacho-dump\b",
238                 NOJUNK + r"\bopt\b",
239                 r"\bFileCheck\b",
240                 r"\bobj2yaml\b",
241                 r"\byaml2obj\b",
242                 r"\bverify-uselistorder\b",
243                 # Handle these specially as they are strings searched
244                 # for during testing.
245                 r"\| \bcount\b",
246                 r"\| \bnot\b"]:
247     # Extract the tool name from the pattern.  This relies on the tool
248     # name being surrounded by \b word match operators.  If the
249     # pattern starts with "| ", include it in the string to be
250     # substituted.
251     tool_match = re.match(r"^(\\)?((\| )?)\W+b([0-9A-Za-z-_]+)\\b\W*$",
252                           pattern)
253     tool_pipe = tool_match.group(2)
254     tool_name = tool_match.group(4)
255     tool_path = lit.util.which(tool_name, llvm_tools_dir)
256     if not tool_path:
257         # Warn, but still provide a substitution.
258         lit_config.note('Did not find ' + tool_name + ' in ' + llvm_tools_dir)
259         tool_path = llvm_tools_dir + '/' + tool_name
260     config.substitutions.append((pattern, tool_pipe + tool_path))
261
262 ### Targets
263
264 config.targets = frozenset(config.targets_to_build.split())
265
266 ### Features
267
268 # Shell execution
269 if execute_external:
270     config.available_features.add('shell')
271
272 # Others/can-execute.txt
273 if sys.platform not in ['win32']:
274     config.available_features.add('can-execute')
275
276 # Loadable module
277 # FIXME: This should be supplied by Makefile or autoconf.
278 if sys.platform in ['win32', 'cygwin']:
279     loadable_module = (config.enable_shared == 1)
280 else:
281     loadable_module = True
282
283 if loadable_module:
284     config.available_features.add('loadable_module')
285
286 # Sanitizers.
287 if config.llvm_use_sanitizer == "Address":
288     config.available_features.add("asan")
289 if (config.llvm_use_sanitizer == "Memory" or
290         config.llvm_use_sanitizer == "MemoryWithOrigins"):
291     config.available_features.add("msan")
292 if config.llvm_use_sanitizer == "Undefined":
293     config.available_features.add("ubsan")
294 else:
295     config.available_features.add("not_ubsan")
296
297 # Direct object generation
298 # Suppress x86_64-mingw32 while investigating since r219108.
299 if not 'hexagon' in config.target_triple and not re.match(r'^x86_64.*-(mingw32|win32)', config.target_triple):
300     config.available_features.add("object-emission")
301
302 if config.have_zlib == "1":
303     config.available_features.add("zlib")
304 else:
305     config.available_features.add("nozlib")
306
307 # Native compilation: host arch == target arch
308 # FIXME: Consider cases that target can be executed
309 # even if host_triple were different from target_triple.
310 if config.host_triple == config.target_triple:
311     config.available_features.add("native")
312
313 import subprocess
314
315 def have_ld_plugin_support():
316     if not os.path.exists(os.path.join(config.llvm_shlib_dir, 'LLVMgold.so')):
317         return False
318
319     ld_cmd = subprocess.Popen(['ld', '--help'], stdout = subprocess.PIPE)
320     if not '-plugin' in ld_cmd.stdout.read():
321         return False
322     ld_cmd.wait()
323
324     ld_version = subprocess.Popen(['ld', '--version'], stdout = subprocess.PIPE)
325     if not 'GNU gold' in ld_version.stdout.read():
326         return False
327     ld_version.wait()
328
329     return True
330
331 if have_ld_plugin_support():
332     config.available_features.add('ld_plugin')
333
334 # Ask llvm-config about assertion mode.
335 try:
336     llvm_config_cmd = subprocess.Popen(
337         [os.path.join(llvm_tools_dir, 'llvm-config'), '--assertion-mode'],
338         stdout = subprocess.PIPE,
339         env=config.environment)
340 except OSError:
341     print("Could not find llvm-config in " + llvm_tools_dir)
342     exit(42)
343
344 if re.search(r'ON', llvm_config_cmd.stdout.read().decode('ascii')):
345     config.available_features.add('asserts')
346 llvm_config_cmd.wait()
347
348 if 'darwin' == sys.platform:
349     try:
350         sysctl_cmd = subprocess.Popen(['sysctl', 'hw.optional.fma'],
351                                     stdout = subprocess.PIPE)
352     except OSError:
353         print("Could not exec sysctl")
354     result = sysctl_cmd.stdout.read().decode('ascii')
355     if -1 != result.find("hw.optional.fma: 1"):
356         config.available_features.add('fma3')
357     sysctl_cmd.wait()
358
359 # .debug_frame is not emitted for targeting Windows x64.
360 if not re.match(r'^x86_64.*-(mingw32|win32)', config.target_triple):
361     config.available_features.add('debug_frame')
362
363 # Check if we should use gmalloc.
364 use_gmalloc_str = lit_config.params.get('use_gmalloc', None)
365 if use_gmalloc_str is not None:
366     if use_gmalloc_str.lower() in ('1', 'true'):
367         use_gmalloc = True
368     elif use_gmalloc_str.lower() in ('', '0', 'false'):
369         use_gmalloc = False
370     else:
371         lit_config.fatal('user parameter use_gmalloc should be 0 or 1')
372 else:
373     # Default to not using gmalloc
374     use_gmalloc = False
375
376 # Allow use of an explicit path for gmalloc library.
377 # Will default to '/usr/lib/libgmalloc.dylib' if not set.
378 gmalloc_path_str = lit_config.params.get('gmalloc_path',
379                                          '/usr/lib/libgmalloc.dylib')
380
381 if use_gmalloc:
382      config.environment.update({'DYLD_INSERT_LIBRARIES' : gmalloc_path_str})