3 # Configuration file for the 'lit' test runner.
13 # name: The name of this test suite.
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'])
24 path = os.path.pathsep.join((path,
25 config.environment['PATH']))
26 config.environment['PATH'] = path
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")
32 # 0 is external, "" is default, and everything else is internal.
33 execute_external = (use_lit_shell == "0")
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'])
39 # testFormat: The test format to use to interpret tests.
40 config.test_format = lit.formats.ShTest(execute_external)
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']
46 # excludes: A list of directories to exclude from the testsuite. The 'Inputs'
47 # subdirectories contain auxiliary inputs for various tests in their parent
49 config.excludes = ['Inputs', 'CMakeLists.txt', 'README.txt', 'LICENSE.txt']
51 # test_source_root: The root path where tests are located.
52 config.test_source_root = os.path.dirname(__file__)
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')
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
67 # Propagate 'HOME' through the environment.
68 if 'HOME' in os.environ:
69 config.environment['HOME'] = os.environ['HOME']
71 # Propagate 'INCLUDE' through the environment.
72 if 'INCLUDE' in os.environ:
73 config.environment['INCLUDE'] = os.environ['INCLUDE']
75 # Propagate 'LIB' through the environment.
76 if 'LIB' in os.environ:
77 config.environment['LIB'] = os.environ['LIB']
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']
86 # Propagate LLVM_SRC_ROOT into the environment.
87 config.environment['LLVM_SRC_ROOT'] = getattr(config, 'llvm_src_root', '')
89 # Propagate PYTHON_EXECUTABLE into the environment
90 config.environment['PYTHON_EXECUTABLE'] = getattr(config, 'python_executable',
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]
98 # Propagate options for sanitizers.
99 for options in ['ASAN_OPTIONS']:
100 if options in os.environ:
101 config.environment[options] = os.environ[options]
107 # Check that the object root is known.
108 if config.test_exec_root is None:
109 # Otherwise, we haven't loaded the site specific configuration (the user is
110 # probably trying to run on a test file directly, and either the site
111 # configuration hasn't been created by the build system, or we are in an
112 # out-of-tree build situation).
114 # Check for 'llvm_site_config' user parameter, and use that if available.
115 site_cfg = lit_config.params.get('llvm_site_config', None)
116 if site_cfg and os.path.exists(site_cfg):
117 lit_config.load_config(config, site_cfg)
120 # Try to detect the situation where we are using an out-of-tree build by
121 # looking for 'llvm-config'.
123 # FIXME: I debated (i.e., wrote and threw away) adding logic to
124 # automagically generate the lit.site.cfg if we are in some kind of fresh
125 # build situation. This means knowing how to invoke the build system
126 # though, and I decided it was too much magic.
128 llvm_config = lit.util.which('llvm-config', config.environment['PATH'])
130 lit_config.fatal('No site specific configuration available!')
132 # Get the source and object roots.
133 llvm_src_root = lit.util.capture(['llvm-config', '--src-root']).strip()
134 llvm_obj_root = lit.util.capture(['llvm-config', '--obj-root']).strip()
136 # Validate that we got a tree which points to here.
137 this_src_root = os.path.dirname(config.test_source_root)
138 if os.path.realpath(llvm_src_root) != os.path.realpath(this_src_root):
139 lit_config.fatal('No site specific configuration available!')
141 # Check that the site specific configuration exists.
142 site_cfg = os.path.join(llvm_obj_root, 'test', 'lit.site.cfg')
143 if not os.path.exists(site_cfg):
144 lit_config.fatal('No site specific configuration available!')
146 # Okay, that worked. Notify the user of the automagic, and reconfigure.
147 lit_config.note('using out-of-tree build at %r' % llvm_obj_root)
148 lit_config.load_config(config, site_cfg)
153 # Provide a command line for mcjit tests
154 lli_mcjit = 'lli -use-mcjit'
155 # The target triple used by default by lli is the process target triple (some
156 # triple appropriate for generating code for the current process) but because
157 # we don't support COFF in MCJIT well enough for the tests, force ELF format on
158 # Windows. FIXME: the process target triple should be used here, but this is
159 # difficult to obtain on Windows.
160 if re.search(r'cygwin|mingw32|win32', config.host_triple):
161 lli_mcjit += ' -mtriple='+config.host_triple+'-elf'
162 config.substitutions.append( ('%lli_mcjit', lli_mcjit) )
164 # Similarly, have a macro to use llc with DWARF even when the host is win32.
166 if re.search(r'win32', config.target_triple):
167 llc_dwarf += ' -mtriple='+config.target_triple.replace('-win32', '-mingw32')
168 config.substitutions.append( ('%llc_dwarf', llc_dwarf) )
170 # Process jit implementation option
171 jit_impl_cfg = lit_config.params.get('jit_impl', None)
172 if jit_impl_cfg == 'mcjit':
173 # When running with mcjit, mangle -mcjit into target triple
174 # and add -use-mcjit flag to lli invocation
175 if 'i386' in config.target_triple or 'i686' in config.target_triple:
176 config.target_triple += jit_impl_cfg + '-ia32'
177 elif 'x86_64' in config.target_triple:
178 config.target_triple += jit_impl_cfg + '-ia64'
180 config.target_triple += jit_impl_cfg
182 config.substitutions.append( ('%lli', 'lli -use-mcjit') )
184 config.substitutions.append( ('%lli', 'lli') )
186 # Add site-specific substitutions.
187 config.substitutions.append( ('%ocamlopt', config.ocamlopt_executable) )
188 config.substitutions.append( ('%llvmshlibdir', config.llvm_shlib_dir) )
189 config.substitutions.append( ('%shlibext', config.llvm_shlib_ext) )
190 config.substitutions.append( ('%exeext', config.llvm_exe_ext) )
191 config.substitutions.append( ('%python', config.python_executable) )
193 # For each occurrence of an llvm tool name as its own word, replace it
194 # with the full path to the build directory holding that tool. This
195 # ensures that we are testing the tools just built and not some random
196 # tools that might happen to be in the user's PATH. Thus this list
197 # includes every tool placed in $(LLVM_OBJ_ROOT)/$(BuildMode)/bin
198 # (llvm_tools_dir in lit parlance).
200 # Avoid matching RUN line fragments that are actually part of
201 # path names or options or whatever.
202 # The regex is a pre-assertion to avoid matching a preceding
203 # dot, hyphen, carat, or slash (.foo, -foo, etc.). Some patterns
204 # also have a post-assertion to not match a trailing hyphen (foo-).
205 NOJUNK = r"(?<!\.|-|\^|/)"
207 for pattern in [r"\bbugpoint\b(?!-)",
212 r"\bllvm-bcanalyzer\b",
217 r"\bllvm-dwarfdump\b",
222 r"\bllvm-mcmarkup\b",
225 r"\bllvm-profdata\b",
231 r"\bllvm-uselistorder\b",
232 r"\bllvm-vtabledump\b",
239 # Handle these specially as they are strings searched
240 # for during testing.
243 # Extract the tool name from the pattern. This relies on the tool
244 # name being surrounded by \b word match operators. If the
245 # pattern starts with "| ", include it in the string to be
247 tool_match = re.match(r"^(\\)?((\| )?)\W+b([0-9A-Za-z-_]+)\\b\W*$",
249 tool_pipe = tool_match.group(2)
250 tool_name = tool_match.group(4)
251 tool_path = lit.util.which(tool_name, llvm_tools_dir)
253 # Warn, but still provide a substitution.
254 lit_config.note('Did not find ' + tool_name + ' in ' + llvm_tools_dir)
255 tool_path = llvm_tools_dir + '/' + tool_name
256 config.substitutions.append((pattern, tool_pipe + tool_path))
260 config.targets = frozenset(config.targets_to_build.split())
266 config.available_features.add('shell')
268 # Others/can-execute.txt
269 if sys.platform not in ['win32']:
270 config.available_features.add('can-execute')
273 # FIXME: This should be supplied by Makefile or autoconf.
274 if sys.platform in ['win32', 'cygwin']:
275 loadable_module = (config.enable_shared == 1)
277 loadable_module = True
280 config.available_features.add('loadable_module')
283 if config.llvm_use_sanitizer == "Address":
284 config.available_features.add("asan")
285 if (config.llvm_use_sanitizer == "Memory" or
286 config.llvm_use_sanitizer == "MemoryWithOrigins"):
287 config.available_features.add("msan")
289 # Direct object generation
290 if not 'hexagon' in config.target_triple:
291 config.available_features.add("object-emission")
293 if config.have_zlib == "1":
294 config.available_features.add("zlib")
296 config.available_features.add("nozlib")
298 # Native compilation: host arch == target arch
299 # FIXME: Consider cases that target can be executed
300 # even if host_triple were different from target_triple.
301 if config.host_triple == config.target_triple:
302 config.available_features.add("native")
306 def have_ld_plugin_support():
307 if not os.path.exists(os.path.join(config.llvm_shlib_dir, 'LLVMgold.so')):
310 ld_cmd = subprocess.Popen(['ld', '--help'], stdout = subprocess.PIPE)
311 if not '-plugin' in ld_cmd.stdout.read():
315 ld_version = subprocess.Popen(['ld', '--version'], stdout = subprocess.PIPE)
316 if not 'GNU gold' in ld_version.stdout.read():
322 if have_ld_plugin_support():
323 config.available_features.add('ld_plugin')
325 # Ask llvm-config about assertion mode.
327 llvm_config_cmd = subprocess.Popen(
328 [os.path.join(llvm_tools_dir, 'llvm-config'), '--assertion-mode'],
329 stdout = subprocess.PIPE)
331 print("Could not find llvm-config in " + llvm_tools_dir)
334 if re.search(r'ON', llvm_config_cmd.stdout.read().decode('ascii')):
335 config.available_features.add('asserts')
336 llvm_config_cmd.wait()
338 if 'darwin' == sys.platform:
340 sysctl_cmd = subprocess.Popen(['sysctl', 'hw.optional.fma'],
341 stdout = subprocess.PIPE)
343 print("Could not exec sysctl")
344 result = sysctl_cmd.stdout.read().decode('ascii')
345 if -1 != result.find("hw.optional.fma: 1"):
346 config.available_features.add('fma3')
349 # .debug_frame is not emitted for targeting Windows x64.
350 if not re.match(r'^x86_64.*-(mingw32|win32)', config.target_triple):
351 config.available_features.add('debug_frame')
353 # Check if we should use gmalloc.
354 use_gmalloc_str = lit_config.params.get('use_gmalloc', None)
355 if use_gmalloc_str is not None:
356 if use_gmalloc_str.lower() in ('1', 'true'):
358 elif use_gmalloc_str.lower() in ('', '0', 'false'):
361 lit_config.fatal('user parameter use_gmalloc should be 0 or 1')
363 # Default to not using gmalloc
366 # Allow use of an explicit path for gmalloc library.
367 # Will default to '/usr/lib/libgmalloc.dylib' if not set.
368 gmalloc_path_str = lit_config.params.get('gmalloc_path',
369 '/usr/lib/libgmalloc.dylib')
372 config.environment.update({'DYLD_INSERT_LIBRARIES' : gmalloc_path_str})