Daniel Dunbar | 1db467f | 2009-07-31 05:54:17 +0000 | [diff] [blame] | 1 | # -*- Python -*- |
| 2 | |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 3 | import os |
Daniel Dunbar | b850ddd | 2009-09-22 10:08:03 +0000 | [diff] [blame] | 4 | import platform |
Chandler Carruth | b40fd3f | 2011-11-05 20:55:50 +0000 | [diff] [blame] | 5 | import re |
| 6 | import subprocess |
Argyrios Kyrtzidis | 4182ed6 | 2012-10-31 20:59:50 +0000 | [diff] [blame] | 7 | import tempfile |
Chandler Carruth | b40fd3f | 2011-11-05 20:55:50 +0000 | [diff] [blame] | 8 | |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 9 | import lit.formats |
| 10 | import lit.util |
Daniel Dunbar | 724827f | 2009-09-08 16:39:23 +0000 | [diff] [blame] | 11 | |
Daniel Dunbar | 1db467f | 2009-07-31 05:54:17 +0000 | [diff] [blame] | 12 | # Configuration file for the 'lit' test runner. |
| 13 | |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 14 | # name: The name of this test suite. |
| 15 | config.name = 'Clang' |
Daniel Dunbar | 724827f | 2009-09-08 16:39:23 +0000 | [diff] [blame] | 16 | |
NAKAMURA Takumi | 98af1ac | 2011-02-09 04:19:57 +0000 | [diff] [blame] | 17 | # Tweak PATH for Win32 |
| 18 | if platform.system() == 'Windows': |
| 19 | # Seek sane tools in directories and set to $PATH. |
| 20 | path = getattr(config, 'lit_tools_dir', None) |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 21 | path = lit_config.getToolsPath(path, |
| 22 | config.environment['PATH'], |
| 23 | ['cmp.exe', 'grep.exe', 'sed.exe']) |
NAKAMURA Takumi | 98af1ac | 2011-02-09 04:19:57 +0000 | [diff] [blame] | 24 | if path is not None: |
| 25 | path = os.path.pathsep.join((path, |
| 26 | config.environment['PATH'])) |
| 27 | config.environment['PATH'] = path |
| 28 | |
Reid Kleckner | a53763f | 2013-04-11 13:34:18 +0000 | [diff] [blame] | 29 | # Choose between lit's internal shell pipeline runner and a real shell. If |
| 30 | # LIT_USE_INTERNAL_SHELL is in the environment, we use that as an override. |
| 31 | use_lit_shell = os.environ.get("LIT_USE_INTERNAL_SHELL") |
| 32 | if use_lit_shell: |
| 33 | # 0 is external, "" is default, and everything else is internal. |
| 34 | execute_external = (use_lit_shell == "0") |
| 35 | else: |
| 36 | # Otherwise we default to internal on Windows and external elsewhere, as |
| 37 | # bash on Windows is usually very slow. |
| 38 | execute_external = (not sys.platform in ['win32']) |
| 39 | |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 40 | # testFormat: The test format to use to interpret tests. |
Daniel Dunbar | 1db467f | 2009-07-31 05:54:17 +0000 | [diff] [blame] | 41 | # |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 42 | # For now we require '&&' between commands, until they get globally killed and |
| 43 | # the test runner updated. |
Daniel Dunbar | bc20ef3 | 2009-11-08 01:47:35 +0000 | [diff] [blame] | 44 | config.test_format = lit.formats.ShTest(execute_external) |
Daniel Dunbar | 6827f3f | 2009-09-06 01:31:12 +0000 | [diff] [blame] | 45 | |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 46 | # suffixes: A list of file extensions to treat as test files. |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 47 | config.suffixes = ['.c', '.cpp', '.m', '.mm', '.cu', '.ll', '.cl', '.s', '.S'] |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 48 | |
Alp Toker | 6c6fd7e | 2013-11-15 13:37:49 +0000 | [diff] [blame] | 49 | # excludes: A list of directories to exclude from the testsuite. The 'Inputs' |
| 50 | # subdirectories contain auxiliary inputs for various tests in their parent |
| 51 | # directories. |
| 52 | config.excludes = ['Inputs', 'CMakeLists.txt', 'README.txt', 'LICENSE.txt'] |
| 53 | |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 54 | # test_source_root: The root path where tests are located. |
| 55 | config.test_source_root = os.path.dirname(__file__) |
| 56 | |
| 57 | # test_exec_root: The root path where tests should be run. |
| 58 | clang_obj_root = getattr(config, 'clang_obj_root', None) |
| 59 | if clang_obj_root is not None: |
| 60 | config.test_exec_root = os.path.join(clang_obj_root, 'test') |
| 61 | |
| 62 | # Set llvm_{src,obj}_root for use by others. |
| 63 | config.llvm_src_root = getattr(config, 'llvm_src_root', None) |
| 64 | config.llvm_obj_root = getattr(config, 'llvm_obj_root', None) |
| 65 | |
Jordy Rose | 40f45ee | 2012-04-06 18:14:01 +0000 | [diff] [blame] | 66 | # Clear some environment variables that might affect Clang. |
| 67 | # |
| 68 | # This first set of vars are read by Clang, but shouldn't affect tests |
| 69 | # that aren't specifically looking for these features, or are required |
| 70 | # simply to run the tests at all. |
| 71 | # |
| 72 | # FIXME: Should we have a tool that enforces this? |
| 73 | |
| 74 | # safe_env_vars = ('TMPDIR', 'TEMP', 'TMP', 'USERPROFILE', 'PWD', |
| 75 | # 'MACOSX_DEPLOYMENT_TARGET', 'IPHONEOS_DEPLOYMENT_TARGET', |
| 76 | # 'IOS_SIMULATOR_DEPLOYMENT_TARGET', |
| 77 | # 'VCINSTALLDIR', 'VC100COMNTOOLS', 'VC90COMNTOOLS', |
| 78 | # 'VC80COMNTOOLS') |
NAKAMURA Takumi | 79c5f95 | 2012-04-07 01:02:53 +0000 | [diff] [blame] | 79 | possibly_dangerous_env_vars = ['COMPILER_PATH', 'RC_DEBUG_OPTIONS', |
Jordy Rose | 40f45ee | 2012-04-06 18:14:01 +0000 | [diff] [blame] | 80 | 'CINDEXTEST_PREAMBLE_FILE', 'LIBRARY_PATH', |
| 81 | 'CPATH', 'C_INCLUDE_PATH', 'CPLUS_INCLUDE_PATH', |
| 82 | 'OBJC_INCLUDE_PATH', 'OBJCPLUS_INCLUDE_PATH', |
| 83 | 'LIBCLANG_TIMING', 'LIBCLANG_OBJTRACKING', |
| 84 | 'LIBCLANG_LOGGING', 'LIBCLANG_BGPRIO_INDEX', |
| 85 | 'LIBCLANG_BGPRIO_EDIT', 'LIBCLANG_NOTHREADS', |
| 86 | 'LIBCLANG_RESOURCE_USAGE', |
NAKAMURA Takumi | 79c5f95 | 2012-04-07 01:02:53 +0000 | [diff] [blame] | 87 | 'LIBCLANG_CODE_COMPLETION_LOGGING'] |
| 88 | # Clang/Win32 may refer to %INCLUDE%. vsvarsall.bat sets it. |
| 89 | if platform.system() != 'Windows': |
| 90 | possibly_dangerous_env_vars.append('INCLUDE') |
Jordy Rose | 40f45ee | 2012-04-06 18:14:01 +0000 | [diff] [blame] | 91 | for name in possibly_dangerous_env_vars: |
| 92 | if name in config.environment: |
| 93 | del config.environment[name] |
| 94 | |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 95 | # Tweak the PATH to include the tools dir and the scripts dir. |
| 96 | if clang_obj_root is not None: |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 97 | clang_tools_dir = getattr(config, 'clang_tools_dir', None) |
| 98 | if not clang_tools_dir: |
| 99 | lit_config.fatal('No Clang tools dir set!') |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 100 | llvm_tools_dir = getattr(config, 'llvm_tools_dir', None) |
| 101 | if not llvm_tools_dir: |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 102 | lit_config.fatal('No LLVM tools dir set!') |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 103 | path = os.path.pathsep.join(( |
| 104 | clang_tools_dir, llvm_tools_dir, config.environment['PATH'])) |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 105 | config.environment['PATH'] = path |
Daniel Dunbar | 9e10cc7 | 2009-09-26 07:36:09 +0000 | [diff] [blame] | 106 | llvm_libs_dir = getattr(config, 'llvm_libs_dir', None) |
| 107 | if not llvm_libs_dir: |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 108 | lit_config.fatal('No LLVM libs dir set!') |
Daniel Dunbar | 9e10cc7 | 2009-09-26 07:36:09 +0000 | [diff] [blame] | 109 | path = os.path.pathsep.join((llvm_libs_dir, |
| 110 | config.environment.get('LD_LIBRARY_PATH',''))) |
| 111 | config.environment['LD_LIBRARY_PATH'] = path |
| 112 | |
Alexey Samsonov | 32d2a65 | 2013-04-04 07:41:20 +0000 | [diff] [blame] | 113 | # Propagate path to symbolizer for ASan/MSan. |
| 114 | for symbolizer in ['ASAN_SYMBOLIZER_PATH', 'MSAN_SYMBOLIZER_PATH']: |
| 115 | if symbolizer in os.environ: |
| 116 | config.environment[symbolizer] = os.environ[symbolizer] |
| 117 | |
Stephen Hines | 6bcf27b | 2014-05-29 04:14:42 -0700 | [diff] [blame^] | 118 | # Propagate options for sanitizers. |
| 119 | for options in ['ASAN_OPTIONS']: |
| 120 | if options in os.environ: |
| 121 | config.environment[options] = os.environ[options] |
| 122 | |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 123 | ### |
| 124 | |
| 125 | # Check that the object root is known. |
| 126 | if config.test_exec_root is None: |
| 127 | # Otherwise, we haven't loaded the site specific configuration (the user is |
| 128 | # probably trying to run on a test file directly, and either the site |
| 129 | # configuration hasn't been created by the build system, or we are in an |
| 130 | # out-of-tree build situation). |
| 131 | |
Daniel Dunbar | b258d8f | 2009-11-05 16:36:19 +0000 | [diff] [blame] | 132 | # Check for 'clang_site_config' user parameter, and use that if available. |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 133 | site_cfg = lit_config.params.get('clang_site_config', None) |
Daniel Dunbar | b258d8f | 2009-11-05 16:36:19 +0000 | [diff] [blame] | 134 | if site_cfg and os.path.exists(site_cfg): |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 135 | lit_config.load_config(config, site_cfg) |
Daniel Dunbar | b258d8f | 2009-11-05 16:36:19 +0000 | [diff] [blame] | 136 | raise SystemExit |
| 137 | |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 138 | # Try to detect the situation where we are using an out-of-tree build by |
| 139 | # looking for 'llvm-config'. |
| 140 | # |
| 141 | # FIXME: I debated (i.e., wrote and threw away) adding logic to |
| 142 | # automagically generate the lit.site.cfg if we are in some kind of fresh |
Daniel Dunbar | 2335421 | 2009-11-07 23:53:17 +0000 | [diff] [blame] | 143 | # build situation. This means knowing how to invoke the build system though, |
| 144 | # and I decided it was too much magic. We should solve this by just having |
| 145 | # the .cfg files generated during the configuration step. |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 146 | |
| 147 | llvm_config = lit.util.which('llvm-config', config.environment['PATH']) |
| 148 | if not llvm_config: |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 149 | lit_config.fatal('No site specific configuration available!') |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 150 | |
| 151 | # Get the source and object roots. |
| 152 | llvm_src_root = lit.util.capture(['llvm-config', '--src-root']).strip() |
| 153 | llvm_obj_root = lit.util.capture(['llvm-config', '--obj-root']).strip() |
| 154 | clang_src_root = os.path.join(llvm_src_root, "tools", "clang") |
| 155 | clang_obj_root = os.path.join(llvm_obj_root, "tools", "clang") |
| 156 | |
| 157 | # Validate that we got a tree which points to here, using the standard |
| 158 | # tools/clang layout. |
| 159 | this_src_root = os.path.dirname(config.test_source_root) |
| 160 | if os.path.realpath(clang_src_root) != os.path.realpath(this_src_root): |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 161 | lit_config.fatal('No site specific configuration available!') |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 162 | |
| 163 | # Check that the site specific configuration exists. |
| 164 | site_cfg = os.path.join(clang_obj_root, 'test', 'lit.site.cfg') |
| 165 | if not os.path.exists(site_cfg): |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 166 | lit_config.fatal( |
| 167 | 'No site specific configuration available! You may need to ' |
| 168 | 'run "make test" in your Clang build directory.') |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 169 | |
| 170 | # Okay, that worked. Notify the user of the automagic, and reconfigure. |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 171 | lit_config.note('using out-of-tree build at %r' % clang_obj_root) |
| 172 | lit_config.load_config(config, site_cfg) |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 173 | raise SystemExit |
| 174 | |
| 175 | ### |
| 176 | |
| 177 | # Discover the 'clang' and 'clangcc' to use. |
| 178 | |
| 179 | import os |
| 180 | |
| 181 | def inferClang(PATH): |
| 182 | # Determine which clang to use. |
| 183 | clang = os.getenv('CLANG') |
| 184 | |
| 185 | # If the user set clang in the environment, definitely use that and don't |
| 186 | # try to validate. |
| 187 | if clang: |
| 188 | return clang |
| 189 | |
| 190 | # Otherwise look in the path. |
| 191 | clang = lit.util.which('clang', PATH) |
| 192 | |
| 193 | if not clang: |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 194 | lit_config.fatal("couldn't find 'clang' program, try setting " |
| 195 | "CLANG in your environment") |
Daniel Dunbar | 5e01e3c | 2009-09-22 05:16:02 +0000 | [diff] [blame] | 196 | |
| 197 | return clang |
| 198 | |
NAKAMURA Takumi | 9085e6f | 2011-03-05 11:16:06 +0000 | [diff] [blame] | 199 | config.clang = inferClang(config.environment['PATH']).replace('\\', '/') |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 200 | if not lit_config.quiet: |
| 201 | lit_config.note('using clang: %r' % config.clang) |
Chandler Carruth | 044a790c | 2011-11-05 10:15:27 +0000 | [diff] [blame] | 202 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 203 | # Plugins (loadable modules) |
| 204 | # TODO: This should be supplied by Makefile or autoconf. |
| 205 | if sys.platform in ['win32', 'cygwin']: |
| 206 | has_plugins = (config.enable_shared == 1) |
| 207 | else: |
| 208 | has_plugins = True |
| 209 | |
| 210 | if has_plugins and config.llvm_plugin_ext: |
| 211 | config.available_features.add('plugins') |
| 212 | |
| 213 | config.substitutions.append( ('%llvmshlibdir', config.llvm_shlib_dir) ) |
| 214 | config.substitutions.append( ('%pluginext', config.llvm_plugin_ext) ) |
| 215 | |
| 216 | if config.clang_examples: |
| 217 | config.available_features.add('examples') |
| 218 | |
Chandler Carruth | 044a790c | 2011-11-05 10:15:27 +0000 | [diff] [blame] | 219 | # Note that when substituting %clang_cc1 also fill in the include directory of |
| 220 | # the builtin headers. Those are part of even a freestanding environment, but |
| 221 | # Clang relies on the driver to locate them. |
Chandler Carruth | df0a4c3 | 2011-11-05 23:29:28 +0000 | [diff] [blame] | 222 | def getClangBuiltinIncludeDir(clang): |
Chandler Carruth | b40fd3f | 2011-11-05 20:55:50 +0000 | [diff] [blame] | 223 | # FIXME: Rather than just getting the version, we should have clang print |
| 224 | # out its resource dir here in an easy to scrape form. |
Chandler Carruth | df0a4c3 | 2011-11-05 23:29:28 +0000 | [diff] [blame] | 225 | cmd = subprocess.Popen([clang, '-print-file-name=include'], |
| 226 | stdout=subprocess.PIPE) |
| 227 | if not cmd.stdout: |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 228 | lit_config.fatal("Couldn't find the include dir for Clang ('%s')" % clang) |
NAKAMURA Takumi | 5407d4a | 2013-06-26 10:45:20 +0000 | [diff] [blame] | 229 | dir = cmd.stdout.read().strip() |
| 230 | if sys.platform in ['win32'] and execute_external: |
| 231 | # Don't pass dosish path separator to msys bash.exe. |
| 232 | dir = dir.replace('\\', '/') |
Daniel Dunbar | 03f443a | 2013-08-14 16:32:20 +0000 | [diff] [blame] | 233 | # Ensure the result is an ascii string, across Python2.5+ - Python3. |
| 234 | return str(dir.decode('ascii')) |
Chandler Carruth | b40fd3f | 2011-11-05 20:55:50 +0000 | [diff] [blame] | 235 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 236 | def makeItaniumABITriple(triple): |
| 237 | m = re.match(r'(\w+)-(\w+)-(\w+)', triple) |
| 238 | if not m: |
| 239 | lit_config.fatal("Could not turn '%s' into Itanium ABI triple" % triple) |
| 240 | if m.group(3).lower() != 'win32': |
| 241 | # All non-win32 triples use the Itanium ABI. |
| 242 | return triple |
| 243 | return m.group(1) + '-' + m.group(2) + '-mingw32' |
| 244 | |
| 245 | def makeMSABITriple(triple): |
| 246 | m = re.match(r'(\w+)-(\w+)-(\w+)', triple) |
| 247 | if not m: |
| 248 | lit_config.fatal("Could not turn '%s' into MS ABI triple" % triple) |
| 249 | isa = m.group(1).lower() |
| 250 | vendor = m.group(2).lower() |
| 251 | os = m.group(3).lower() |
| 252 | if os == 'win32': |
| 253 | # If the OS is win32, we're done. |
| 254 | return triple |
| 255 | if isa.startswith('x86') or isa == 'amd64' or re.match(r'i\d86', isa): |
| 256 | # For x86 ISAs, adjust the OS. |
| 257 | return isa + '-' + vendor + '-win32' |
| 258 | # -win32 is not supported for non-x86 targets; use a default. |
| 259 | return 'i686-pc-win32' |
| 260 | |
Chandler Carruth | 0764308 | 2011-11-07 09:17:31 +0000 | [diff] [blame] | 261 | config.substitutions.append( ('%clang_cc1', '%s -cc1 -internal-isystem %s' |
Chandler Carruth | df0a4c3 | 2011-11-05 23:29:28 +0000 | [diff] [blame] | 262 | % (config.clang, |
| 263 | getClangBuiltinIncludeDir(config.clang))) ) |
Hans Wennborg | 76b86c2 | 2013-07-18 20:29:38 +0000 | [diff] [blame] | 264 | config.substitutions.append( ('%clang_cpp', ' ' + config.clang + |
| 265 | ' --driver-mode=cpp ')) |
Hans Wennborg | c2f531a | 2013-07-19 20:33:20 +0000 | [diff] [blame] | 266 | config.substitutions.append( ('%clang_cl', ' ' + config.clang + |
| 267 | ' --driver-mode=cl ')) |
Daniel Dunbar | 9fde9c4 | 2010-06-29 16:52:24 +0000 | [diff] [blame] | 268 | config.substitutions.append( ('%clangxx', ' ' + config.clang + |
Hans Wennborg | 76b86c2 | 2013-07-18 20:29:38 +0000 | [diff] [blame] | 269 | ' --driver-mode=g++ ')) |
Daniel Dunbar | 80737ad | 2009-12-15 22:01:24 +0000 | [diff] [blame] | 270 | config.substitutions.append( ('%clang', ' ' + config.clang + ' ') ) |
Devang Patel | 8c6b913 | 2010-09-13 20:46:23 +0000 | [diff] [blame] | 271 | config.substitutions.append( ('%test_debuginfo', ' ' + config.llvm_src_root + '/utils/test_debuginfo.pl ') ) |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 272 | config.substitutions.append( ('%itanium_abi_triple', makeItaniumABITriple(config.target_triple)) ) |
| 273 | config.substitutions.append( ('%ms_abi_triple', makeMSABITriple(config.target_triple)) ) |
Daniel Dunbar | a572887 | 2009-12-15 20:14:24 +0000 | [diff] [blame] | 274 | |
Daniel Dunbar | 80737ad | 2009-12-15 22:01:24 +0000 | [diff] [blame] | 275 | # FIXME: Find nicer way to prohibit this. |
| 276 | config.substitutions.append( |
| 277 | (' clang ', """*** Do not use 'clang' in tests, use '%clang'. ***""") ) |
| 278 | config.substitutions.append( |
David Greene | 431feb5 | 2011-01-03 17:28:52 +0000 | [diff] [blame] | 279 | (' clang\+\+ ', """*** Do not use 'clang++' in tests, use '%clangxx'. ***""")) |
Daniel Dunbar | 679d605 | 2010-02-17 20:31:01 +0000 | [diff] [blame] | 280 | config.substitutions.append( |
Daniel Dunbar | 80737ad | 2009-12-15 22:01:24 +0000 | [diff] [blame] | 281 | (' clang-cc ', |
| 282 | """*** Do not use 'clang-cc' in tests, use '%clang_cc1'. ***""") ) |
| 283 | config.substitutions.append( |
| 284 | (' clang -cc1 ', |
| 285 | """*** Do not use 'clang -cc1' in tests, use '%clang_cc1'. ***""") ) |
Daniel Dunbar | 9fde9c4 | 2010-06-29 16:52:24 +0000 | [diff] [blame] | 286 | config.substitutions.append( |
| 287 | (' %clang-cc1 ', |
| 288 | """*** invalid substitution, use '%clang_cc1'. ***""") ) |
Hans Wennborg | 76b86c2 | 2013-07-18 20:29:38 +0000 | [diff] [blame] | 289 | config.substitutions.append( |
| 290 | (' %clang-cpp ', |
| 291 | """*** invalid substitution, use '%clang_cpp'. ***""") ) |
Hans Wennborg | c2f531a | 2013-07-19 20:33:20 +0000 | [diff] [blame] | 292 | config.substitutions.append( |
| 293 | (' %clang-cl ', |
| 294 | """*** invalid substitution, use '%clang_cl'. ***""") ) |
Daniel Dunbar | db91864 | 2010-08-24 21:39:55 +0000 | [diff] [blame] | 295 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 296 | # For each occurrence of a clang tool name as its own word, replace it |
| 297 | # with the full path to the build directory holding that tool. This |
| 298 | # ensures that we are testing the tools just built and not some random |
| 299 | # tools that might happen to be in the user's PATH. |
| 300 | tool_dirs = os.path.pathsep.join((clang_tools_dir, llvm_tools_dir)) |
| 301 | |
| 302 | # Regex assertions to reject neighbor hyphens/dots (seen in some tests). |
| 303 | # For example, don't match 'clang-check-' or '.clang-format'. |
| 304 | NoPreHyphenDot = r"(?<!(-|\.))" |
| 305 | NoPostHyphenDot = r"(?!(-|\.))" |
| 306 | |
| 307 | for pattern in [r"\bFileCheck\b", |
| 308 | r"\bc-index-test\b", |
| 309 | NoPreHyphenDot + r"\bclang-check\b" + NoPostHyphenDot, |
| 310 | NoPreHyphenDot + r"\bclang-format\b" + NoPostHyphenDot, |
Stephen Hines | 6bcf27b | 2014-05-29 04:14:42 -0700 | [diff] [blame^] | 311 | NoPreHyphenDot + r"\bclang-interpreter\b" + NoPostHyphenDot, |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 312 | # FIXME: Some clang test uses opt? |
| 313 | NoPreHyphenDot + r"\bopt\b" + NoPostHyphenDot, |
| 314 | # Handle these specially as they are strings searched |
| 315 | # for during testing. |
| 316 | r"\| \bcount\b", |
| 317 | r"\| \bnot\b"]: |
| 318 | # Extract the tool name from the pattern. This relies on the tool |
| 319 | # name being surrounded by \b word match operators. If the |
| 320 | # pattern starts with "| ", include it in the string to be |
| 321 | # substituted. |
| 322 | tool_match = re.match(r"^(\\)?((\| )?)\W+b([0-9A-Za-z-_]+)\\b\W*$", |
| 323 | pattern) |
| 324 | tool_pipe = tool_match.group(2) |
| 325 | tool_name = tool_match.group(4) |
| 326 | tool_path = lit.util.which(tool_name, tool_dirs) |
| 327 | if not tool_path: |
| 328 | # Warn, but still provide a substitution. |
| 329 | lit_config.note('Did not find ' + tool_name + ' in ' + tool_dirs) |
| 330 | tool_path = clang_tools_dir + '/' + tool_name |
| 331 | config.substitutions.append((pattern, tool_pipe + tool_path)) |
| 332 | |
Daniel Dunbar | db91864 | 2010-08-24 21:39:55 +0000 | [diff] [blame] | 333 | ### |
| 334 | |
| 335 | # Set available features we allow tests to conditionalize on. |
Andrew Trick | 6da28e2 | 2011-08-26 22:46:31 +0000 | [diff] [blame] | 336 | # |
| 337 | # As of 2011.08, crash-recovery tests still do not pass on FreeBSD. |
| 338 | if platform.system() not in ['FreeBSD']: |
| 339 | config.available_features.add('crash-recovery') |
NAKAMURA Takumi | ef34d77 | 2011-02-28 09:41:07 +0000 | [diff] [blame] | 340 | |
| 341 | # Shell execution |
Reid Kleckner | a53763f | 2013-04-11 13:34:18 +0000 | [diff] [blame] | 342 | if execute_external: |
NAKAMURA Takumi | ef34d77 | 2011-02-28 09:41:07 +0000 | [diff] [blame] | 343 | config.available_features.add('shell') |
Galina Kistanova | ee22697 | 2011-06-03 18:36:30 +0000 | [diff] [blame] | 344 | |
NAKAMURA Takumi | 05a10ff | 2013-01-16 06:10:16 +0000 | [diff] [blame] | 345 | # Exclude MSYS due to transforming '/' to 'X:/mingwroot/'. |
Hans Wennborg | de56bb7 | 2013-08-05 20:14:43 +0000 | [diff] [blame] | 346 | if not platform.system() in ['Windows'] or not execute_external: |
NAKAMURA Takumi | 05a10ff | 2013-01-16 06:10:16 +0000 | [diff] [blame] | 347 | config.available_features.add('shell-preserves-root') |
| 348 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 349 | # For tests that require Darwin to run. |
| 350 | # This is used by debuginfo-tests/*block*.m and debuginfo-tests/foreach.m. |
| 351 | if platform.system() in ['Darwin']: |
| 352 | config.available_features.add('system-darwin') |
Stephen Hines | 6bcf27b | 2014-05-29 04:14:42 -0700 | [diff] [blame^] | 353 | elif platform.system() in ['Windows']: |
| 354 | # For tests that require Windows to run. |
| 355 | config.available_features.add('system-windows') |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 356 | |
NAKAMURA Takumi | 5e3d24c | 2012-09-12 10:38:03 +0000 | [diff] [blame] | 357 | # ANSI escape sequences in non-dumb terminal |
NAKAMURA Takumi | 0ca4be3 | 2012-07-11 11:44:00 +0000 | [diff] [blame] | 358 | if platform.system() not in ['Windows']: |
| 359 | config.available_features.add('ansi-escape-sequences') |
| 360 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 361 | # Capability to print utf8 to the terminal. |
| 362 | # Windows expects codepage, unless Wide API. |
| 363 | if platform.system() not in ['Windows']: |
| 364 | config.available_features.add('utf8-capable-terminal') |
| 365 | |
| 366 | # Native compilation: Check if triples match. |
| 367 | # FIXME: Consider cases that target can be executed |
| 368 | # even if host_triple were different from target_triple. |
| 369 | if config.host_triple == config.target_triple: |
Amaury de la Vieuville | 0909859 | 2013-09-13 11:02:31 +0000 | [diff] [blame] | 370 | config.available_features.add("native") |
| 371 | |
Argyrios Kyrtzidis | 4182ed6 | 2012-10-31 20:59:50 +0000 | [diff] [blame] | 372 | # Case-insensitive file system |
| 373 | def is_filesystem_case_insensitive(): |
Argyrios Kyrtzidis | b2ed96a | 2012-11-01 00:59:15 +0000 | [diff] [blame] | 374 | handle, path = tempfile.mkstemp(prefix='case-test', dir=config.test_exec_root) |
NAKAMURA Takumi | 80db6a7 | 2013-07-01 09:51:55 +0000 | [diff] [blame] | 375 | isInsensitive = os.path.exists( |
| 376 | os.path.join( |
| 377 | os.path.dirname(path), |
| 378 | os.path.basename(path).upper() |
| 379 | )) |
Argyrios Kyrtzidis | 4182ed6 | 2012-10-31 20:59:50 +0000 | [diff] [blame] | 380 | os.close(handle) |
| 381 | os.remove(path) |
| 382 | return isInsensitive |
| 383 | |
| 384 | if is_filesystem_case_insensitive(): |
| 385 | config.available_features.add('case-insensitive-filesystem') |
| 386 | |
Daniel Dunbar | 0b95bd0 | 2012-11-15 20:06:10 +0000 | [diff] [blame] | 387 | # Tests that require the /dev/fd filesystem. |
NAKAMURA Takumi | 93308b9 | 2012-11-27 05:25:41 +0000 | [diff] [blame] | 388 | if os.path.exists("/dev/fd/0") and sys.platform not in ['cygwin']: |
Daniel Dunbar | 0b95bd0 | 2012-11-15 20:06:10 +0000 | [diff] [blame] | 389 | config.available_features.add('dev-fd-fs') |
| 390 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 391 | # DW2 Target |
| 392 | if not re.match(r'.*-win32$', config.target_triple): |
| 393 | config.available_features.add('dw2') |
| 394 | |
| 395 | # Not set on native MS environment. |
| 396 | if not re.match(r'.*-win32$', config.target_triple): |
| 397 | config.available_features.add('non-ms-sdk') |
| 398 | |
NAKAMURA Takumi | b774d73 | 2012-09-12 10:45:40 +0000 | [diff] [blame] | 399 | # [PR8833] LLP64-incompatible tests |
| 400 | if not re.match(r'^x86_64.*-(win32|mingw32)$', config.target_triple): |
| 401 | config.available_features.add('LP64') |
| 402 | |
NAKAMURA Takumi | 5e4ccb4 | 2012-12-11 07:06:09 +0000 | [diff] [blame] | 403 | # [PR12920] "clang-driver" -- set if gcc driver is not used. |
| 404 | if not re.match(r'.*-(cygwin|mingw32)$', config.target_triple): |
| 405 | config.available_features.add('clang-driver') |
| 406 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 407 | # [PR18856] Depends to remove opened file. On win32, a file could be removed |
| 408 | # only if all handles were closed. |
| 409 | if platform.system() not in ['Windows']: |
| 410 | config.available_features.add('can-remove-opened-file') |
Galina Kistanova | ee22697 | 2011-06-03 18:36:30 +0000 | [diff] [blame] | 411 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 412 | # Returns set of available features, registered-target(s) and asserts. |
| 413 | def get_llvm_config_props(): |
| 414 | set_of_features = set() |
Galina Kistanova | ee22697 | 2011-06-03 18:36:30 +0000 | [diff] [blame] | 415 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 416 | cmd = subprocess.Popen( |
| 417 | [ |
| 418 | os.path.join(llvm_tools_dir, 'llvm-config'), |
| 419 | '--assertion-mode', |
| 420 | '--targets-built', |
| 421 | ], |
| 422 | stdout=subprocess.PIPE |
| 423 | ) |
| 424 | # 1st line corresponds to --assertion-mode, "ON" or "OFF". |
| 425 | line = cmd.stdout.readline().strip().decode('ascii') |
| 426 | if line == "ON": |
| 427 | set_of_features.add('asserts') |
Galina Kistanova | ee22697 | 2011-06-03 18:36:30 +0000 | [diff] [blame] | 428 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 429 | # 2nd line corresponds to --targets-built, like; |
| 430 | # AArch64 ARM CppBackend X86 |
| 431 | for arch in cmd.stdout.readline().decode('ascii').split(): |
| 432 | set_of_features.add(arch.lower() + '-registered-target') |
Galina Kistanova | ee22697 | 2011-06-03 18:36:30 +0000 | [diff] [blame] | 433 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 434 | return set_of_features |
NAKAMURA Takumi | 6079676 | 2011-11-28 05:09:42 +0000 | [diff] [blame] | 435 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 436 | config.available_features.update(get_llvm_config_props()) |
Dmitri Gribenko | f303d4c | 2012-08-07 17:54:38 +0000 | [diff] [blame] | 437 | |
| 438 | if lit.util.which('xmllint'): |
| 439 | config.available_features.add('xmllint') |
| 440 | |
Alexey Samsonov | 48c0834 | 2013-03-26 08:28:18 +0000 | [diff] [blame] | 441 | # Sanitizers. |
| 442 | if config.llvm_use_sanitizer == "Address": |
| 443 | config.available_features.add("asan") |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 444 | else: |
| 445 | config.available_features.add("not_asan") |
Alexey Samsonov | 48c0834 | 2013-03-26 08:28:18 +0000 | [diff] [blame] | 446 | if (config.llvm_use_sanitizer == "Memory" or |
| 447 | config.llvm_use_sanitizer == "MemoryWithOrigins"): |
| 448 | config.available_features.add("msan") |
Michael Gottesman | 63f4050 | 2013-06-19 23:23:49 +0000 | [diff] [blame] | 449 | |
| 450 | # Check if we should run long running tests. |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 451 | if lit_config.params.get("run_long_tests", None) == "true": |
Michael Gottesman | 63f4050 | 2013-06-19 23:23:49 +0000 | [diff] [blame] | 452 | config.available_features.add("long_tests") |
David Dean | 22d017d | 2013-07-11 23:37:50 +0000 | [diff] [blame] | 453 | |
| 454 | # Check if we should use gmalloc. |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 455 | use_gmalloc_str = lit_config.params.get('use_gmalloc', None) |
David Dean | 22d017d | 2013-07-11 23:37:50 +0000 | [diff] [blame] | 456 | if use_gmalloc_str is not None: |
| 457 | if use_gmalloc_str.lower() in ('1', 'true'): |
| 458 | use_gmalloc = True |
| 459 | elif use_gmalloc_str.lower() in ('', '0', 'false'): |
| 460 | use_gmalloc = False |
| 461 | else: |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 462 | lit_config.fatal('user parameter use_gmalloc should be 0 or 1') |
David Dean | 22d017d | 2013-07-11 23:37:50 +0000 | [diff] [blame] | 463 | else: |
| 464 | # Default to not using gmalloc |
| 465 | use_gmalloc = False |
| 466 | |
| 467 | # Allow use of an explicit path for gmalloc library. |
| 468 | # Will default to '/usr/lib/libgmalloc.dylib' if not set. |
Daniel Dunbar | 4c87ca4 | 2013-08-09 14:43:04 +0000 | [diff] [blame] | 469 | gmalloc_path_str = lit_config.params.get('gmalloc_path', |
| 470 | '/usr/lib/libgmalloc.dylib') |
David Dean | 22d017d | 2013-07-11 23:37:50 +0000 | [diff] [blame] | 471 | if use_gmalloc: |
| 472 | config.environment.update({'DYLD_INSERT_LIBRARIES' : gmalloc_path_str}) |
Daniel Dunbar | 8ad46b7 | 2013-11-06 21:44:54 +0000 | [diff] [blame] | 473 | |
| 474 | # On Darwin, support relocatable SDKs by providing Clang with a |
| 475 | # default system root path. |
| 476 | if 'darwin' in config.target_triple: |
Joerg Sonnenberger | a683404 | 2013-11-14 23:18:08 +0000 | [diff] [blame] | 477 | try: |
| 478 | cmd = subprocess.Popen(['xcrun', '--show-sdk-path'], |
| 479 | stdout=subprocess.PIPE, stderr=subprocess.PIPE) |
| 480 | out, err = cmd.communicate() |
| 481 | out = out.strip() |
| 482 | res = cmd.wait() |
| 483 | except OSError: |
| 484 | res = -1 |
Daniel Dunbar | 8ad46b7 | 2013-11-06 21:44:54 +0000 | [diff] [blame] | 485 | if res == 0 and out: |
| 486 | sdk_path = out |
| 487 | lit_config.note('using SDKROOT: %r' % sdk_path) |
| 488 | config.environment['SDKROOT'] = sdk_path |