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]
102 # Check that the object root is known.
103 if config.test_exec_root is None:
104 # Otherwise, we haven't loaded the site specific configuration (the user is
105 # probably trying to run on a test file directly, and either the site
106 # configuration hasn't been created by the build system, or we are in an
107 # out-of-tree build situation).
109 # Check for 'llvm_site_config' user parameter, and use that if available.
110 site_cfg = lit_config.params.get('llvm_site_config', None)
111 if site_cfg and os.path.exists(site_cfg):
112 lit_config.load_config(config, site_cfg)
115 # Try to detect the situation where we are using an out-of-tree build by
116 # looking for 'llvm-config'.
118 # FIXME: I debated (i.e., wrote and threw away) adding logic to
119 # automagically generate the lit.site.cfg if we are in some kind of fresh
120 # build situation. This means knowing how to invoke the build system
121 # though, and I decided it was too much magic.
123 llvm_config = lit.util.which('llvm-config', config.environment['PATH'])
125 lit_config.fatal('No site specific configuration available!')
127 # Get the source and object roots.
128 llvm_src_root = lit.util.capture(['llvm-config', '--src-root']).strip()
129 llvm_obj_root = lit.util.capture(['llvm-config', '--obj-root']).strip()
131 # Validate that we got a tree which points to here.
132 this_src_root = os.path.dirname(config.test_source_root)
133 if os.path.realpath(llvm_src_root) != os.path.realpath(this_src_root):
134 lit_config.fatal('No site specific configuration available!')
136 # Check that the site specific configuration exists.
137 site_cfg = os.path.join(llvm_obj_root, 'test', 'lit.site.cfg')
138 if not os.path.exists(site_cfg):
139 lit_config.fatal('No site specific configuration available!')
141 # Okay, that worked. Notify the user of the automagic, and reconfigure.
142 lit_config.note('using out-of-tree build at %r' % llvm_obj_root)
143 lit_config.load_config(config, site_cfg)
148 # Provide a command line for mcjit tests
149 lli_mcjit = 'lli -use-mcjit'
150 # The target triple used by default by lli is the process target triple (some
151 # triple appropriate for generating code for the current process) but because
152 # we don't support COFF in MCJIT well enough for the tests, force ELF format on
153 # Windows. FIXME: the process target triple should be used here, but this is
154 # difficult to obtain on Windows.
155 if re.search(r'cygwin|mingw32|win32', config.host_triple):
156 lli_mcjit += ' -mtriple='+config.host_triple+'-elf'
157 config.substitutions.append( ('%lli_mcjit', lli_mcjit) )
159 # Similarly, have a macro to use llc with DWARF even when the host is win32.
161 if re.search(r'win32', config.target_triple):
162 llc_dwarf += ' -mtriple='+config.target_triple.replace('-win32', '-mingw32')
163 config.substitutions.append( ('%llc_dwarf', llc_dwarf) )
165 # Provide a substition for those tests that need to run the jit to obtain data
166 # but simply want use the currently considered most reliable jit for platform
167 # FIXME: ppc32 is not ready for mcjit.
168 if 'arm' in config.target_triple \
169 or 'aarch64' in config.target_triple \
170 or 'powerpc64' in config.target_triple \
171 or 's390x' in config.target_triple:
172 defaultIsMCJIT = 'true'
174 defaultIsMCJIT = 'false'
175 config.substitutions.append( ('%defaultjit', '-use-mcjit='+defaultIsMCJIT) )
177 # Process jit implementation option
178 jit_impl_cfg = lit_config.params.get('jit_impl', None)
179 if jit_impl_cfg == 'mcjit':
180 # When running with mcjit, mangle -mcjit into target triple
181 # and add -use-mcjit flag to lli invocation
182 if 'i386' in config.target_triple or 'i686' in config.target_triple:
183 config.target_triple += jit_impl_cfg + '-ia32'
184 elif 'x86_64' in config.target_triple:
185 config.target_triple += jit_impl_cfg + '-ia64'
187 config.target_triple += jit_impl_cfg
189 config.substitutions.append( ('%lli', 'lli -use-mcjit') )
191 config.substitutions.append( ('%lli', 'lli') )
193 # Add site-specific substitutions.
194 config.substitutions.append( ('%ocamlopt', config.ocamlopt_executable) )
195 config.substitutions.append( ('%llvmshlibdir', config.llvm_shlib_dir) )
196 config.substitutions.append( ('%shlibext', config.llvm_shlib_ext) )
197 config.substitutions.append( ('%exeext', config.llvm_exe_ext) )
199 # For each occurrence of an llvm tool name as its own word, replace it
200 # with the full path to the build directory holding that tool. This
201 # ensures that we are testing the tools just built and not some random
202 # tools that might happen to be in the user's PATH. Thus this list
203 # includes every tool placed in $(LLVM_OBJ_ROOT)/$(BuildMode)/bin
204 # (llvm_tools_dir in lit parlance).
205 # Don't match 'bugpoint-' or 'clang-'.
206 # Don't match '/clang' or '-clang'.
207 if os.pathsep == ';':
208 pathext = os.environ.get('PATHEXT', '').split(';')
211 # Regex to reject matching a hyphen
214 for pattern in [r"\bbugpoint\b(?!-)",
215 r"(?<!/|-)\bclang\b(?!-)",
217 # Match llc but not -llc
218 NOHYPHEN + r"\bllc\b",
220 r"\bllvm-PerfectShuffle\b",
223 r"\bllvm-bcanalyzer\b",
228 r"\bllvm-dwarfdump\b",
230 r"\bllvm-jistlistener\b",
234 r"\bllvm-mcmarkup\b",
237 r"\bllvm-profdata\b",
245 # Match llvmc but not -llvmc
246 NOHYPHEN + r"\bllvmc\b",
247 # Match lto but not -lto
248 NOHYPHEN + r"\blto\b",
250 # Don't match '.opt', '-opt', '^opt' or '/opt'.
251 r"(?<!\.|-|\^|/)\bopt\b",
258 # Handle these specially as they are strings searched
259 # for during testing.
262 # Extract the tool name from the pattern. This relies on the tool
263 # name being surrounded by \b word match operators. If the
264 # pattern starts with "| ", include it in the string to be
266 substitution = re.sub(r"^(\\)?((\| )?)\W+b([0-9A-Za-z-_]+)\\b\W*$",
267 r"\2" + llvm_tools_dir + "/" + r"\4",
270 substitution_ext = substitution + ext
271 if os.path.exists(substitution_ext):
272 substitution = substitution_ext
274 config.substitutions.append((pattern, substitution))
280 config.available_features.add('shell')
282 # Others/can-execute.txt
283 if sys.platform not in ['win32']:
284 config.available_features.add('can-execute')
287 # FIXME: This should be supplied by Makefile or autoconf.
288 if sys.platform in ['win32', 'cygwin']:
289 loadable_module = (config.enable_shared == 1)
291 loadable_module = True
294 config.available_features.add('loadable_module')
297 if config.llvm_use_sanitizer == "Address":
298 config.available_features.add("asan")
299 if (config.llvm_use_sanitizer == "Memory" or
300 config.llvm_use_sanitizer == "MemoryWithOrigins"):
301 config.available_features.add("msan")
303 # Direct object generation
304 if not 'hexagon' in config.target_triple:
305 config.available_features.add("object-emission")
307 if config.have_zlib == "1":
308 config.available_features.add("zlib")
310 # Native compilation: host arch == target arch
311 # FIXME: Consider cases that target can be executed
312 # even if host_triple were different from target_triple.
313 if config.host_triple == config.target_triple:
314 config.available_features.add("native")
316 # Ask llvm-config about assertion mode.
319 llvm_config_cmd = subprocess.Popen(
320 [os.path.join(llvm_tools_dir, 'llvm-config'), '--assertion-mode'],
321 stdout = subprocess.PIPE)
323 print("Could not find llvm-config in " + llvm_tools_dir)
326 if re.search(r'ON', llvm_config_cmd.stdout.read().decode('ascii')):
327 config.available_features.add('asserts')
328 llvm_config_cmd.wait()
330 if 'darwin' == sys.platform:
332 sysctl_cmd = subprocess.Popen(['sysctl', 'hw.optional.fma'],
333 stdout = subprocess.PIPE)
335 print("Could not exec sysctl")
336 result = sysctl_cmd.stdout.read().decode('ascii')
337 if -1 != result.find("hw.optional.fma: 1"):
338 config.available_features.add('fma3')
341 # Check if we should use gmalloc.
342 use_gmalloc_str = lit_config.params.get('use_gmalloc', None)
343 if use_gmalloc_str is not None:
344 if use_gmalloc_str.lower() in ('1', 'true'):
346 elif use_gmalloc_str.lower() in ('', '0', 'false'):
349 lit_config.fatal('user parameter use_gmalloc should be 0 or 1')
351 # Default to not using gmalloc
354 # Allow use of an explicit path for gmalloc library.
355 # Will default to '/usr/lib/libgmalloc.dylib' if not set.
356 gmalloc_path_str = lit_config.params.get('gmalloc_path',
357 '/usr/lib/libgmalloc.dylib')
360 config.environment.update({'DYLD_INSERT_LIBRARIES' : gmalloc_path_str})