1# -*- Python -*- 2 3# Configuration file for the 'lit' test runner. 4 5import os 6import sys 7import re 8import platform 9 10import lit.util 11import lit.formats 12 13# name: The name of this test suite. 14config.name = 'LLVM' 15 16# Tweak PATH for Win32 to decide to use bash.exe or not. 17if 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. 30use_lit_shell = os.environ.get("LIT_USE_INTERNAL_SHELL") 31if use_lit_shell: 32 # 0 is external, "" is default, and everything else is internal. 33 execute_external = (use_lit_shell == "0") 34else: 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. 40config.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. 44config.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. 49config.excludes = ['Inputs', 'CMakeLists.txt', 'README.txt', 'LICENSE.txt'] 50 51# test_source_root: The root path where tests are located. 52config.test_source_root = os.path.dirname(__file__) 53 54# test_exec_root: The root path where tests should be run. 55llvm_obj_root = getattr(config, 'llvm_obj_root', None) 56if 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. 60if 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. 68if 'HOME' in os.environ: 69 config.environment['HOME'] = os.environ['HOME'] 70 71# Propagate 'INCLUDE' through the environment. 72if 'INCLUDE' in os.environ: 73 config.environment['INCLUDE'] = os.environ['INCLUDE'] 74 75# Propagate 'LIB' through the environment. 76if '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. 81if 'TMP' in os.environ: 82 config.environment['TMP'] = os.environ['TMP'] 83if 'TEMP' in os.environ: 84 config.environment['TEMP'] = os.environ['TEMP'] 85 86# Propagate LLVM_SRC_ROOT into the environment. 87config.environment['LLVM_SRC_ROOT'] = getattr(config, 'llvm_src_root', '') 88 89# Propagate PYTHON_EXECUTABLE into the environment 90config.environment['PYTHON_EXECUTABLE'] = getattr(config, 'python_executable', 91 '') 92 93# Propagate path to symbolizer for ASan/MSan. 94for symbolizer in ['ASAN_SYMBOLIZER_PATH', 'MSAN_SYMBOLIZER_PATH']: 95 if symbolizer in os.environ: 96 config.environment[symbolizer] = os.environ[symbolizer] 97 98### 99 100import os 101 102# Check that the object root is known. 103if 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). 108 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) 113 raise SystemExit 114 115 # Try to detect the situation where we are using an out-of-tree build by 116 # looking for 'llvm-config'. 117 # 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. 122 123 llvm_config = lit.util.which('llvm-config', config.environment['PATH']) 124 if not llvm_config: 125 lit_config.fatal('No site specific configuration available!') 126 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() 130 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!') 135 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!') 140 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) 144 raise SystemExit 145 146### 147 148# Provide a command line for mcjit tests 149lli_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. 155if re.search(r'cygwin|mingw32|win32', config.host_triple): 156 lli_mcjit += ' -mtriple='+config.host_triple+'-elf' 157config.substitutions.append( ('%lli_mcjit', lli_mcjit) ) 158 159# Provide a substition for those tests that need to run the jit to obtain data 160# but simply want use the currently considered most reliable jit for platform 161# FIXME: ppc32 is not ready for mcjit. 162if 'arm' in config.target_triple \ 163 or 'aarch64' in config.target_triple \ 164 or 'powerpc64' in config.target_triple \ 165 or 's390x' in config.target_triple: 166 defaultIsMCJIT = 'true' 167else: 168 defaultIsMCJIT = 'false' 169config.substitutions.append( ('%defaultjit', '-use-mcjit='+defaultIsMCJIT) ) 170 171# Process jit implementation option 172jit_impl_cfg = lit_config.params.get('jit_impl', None) 173if jit_impl_cfg == 'mcjit': 174 # When running with mcjit, mangle -mcjit into target triple 175 # and add -use-mcjit flag to lli invocation 176 if 'i386' in config.target_triple or 'i686' in config.target_triple: 177 config.target_triple += jit_impl_cfg + '-ia32' 178 elif 'x86_64' in config.target_triple: 179 config.target_triple += jit_impl_cfg + '-ia64' 180 else: 181 config.target_triple += jit_impl_cfg 182 183 config.substitutions.append( ('%lli', 'lli -use-mcjit') ) 184else: 185 config.substitutions.append( ('%lli', 'lli') ) 186 187# Add site-specific substitutions. 188config.substitutions.append( ('%ocamlopt', config.ocamlopt_executable) ) 189config.substitutions.append( ('%llvmshlibdir', config.llvm_shlib_dir) ) 190config.substitutions.append( ('%shlibext', config.llvm_shlib_ext) ) 191 192# For each occurrence of an llvm tool name as its own word, replace it 193# with the full path to the build directory holding that tool. This 194# ensures that we are testing the tools just built and not some random 195# tools that might happen to be in the user's PATH. Thus this list 196# includes every tool placed in $(LLVM_OBJ_ROOT)/$(BuildMode)/bin 197# (llvm_tools_dir in lit parlance). 198 # Don't match 'bugpoint-' or 'clang-'. 199 # Don't match '/clang' or '-clang'. 200if os.pathsep == ';': 201 pathext = os.environ.get('PATHEXT', '').split(';') 202else: 203 pathext = [''] 204# Regex to reject matching a hyphen 205NOHYPHEN = r"(?<!-)" 206 207for pattern in [r"\bbugpoint\b(?!-)", 208 r"(?<!/|-)\bclang\b(?!-)", 209 r"\bgold\b", 210 # Match llc but not -llc 211 NOHYPHEN + r"\bllc\b", 212 r"\blli\b", 213 r"\bllvm-PerfectShuffle\b", 214 r"\bllvm-ar\b", 215 r"\bllvm-as\b", 216 r"\bllvm-bcanalyzer\b", 217 r"\bllvm-config\b", 218 r"\bllvm-cov\b", 219 r"\bllvm-diff\b", 220 r"\bllvm-dis\b", 221 r"\bllvm-dwarfdump\b", 222 r"\bllvm-extract\b", 223 r"\bllvm-jistlistener\b", 224 r"\bllvm-link\b", 225 r"\bllvm-lto\b", 226 r"\bllvm-mc\b", 227 r"\bllvm-mcmarkup\b", 228 r"\bllvm-nm\b", 229 r"\bllvm-objdump\b", 230 r"\bllvm-ranlib\b", 231 r"\bllvm-readobj\b", 232 r"\bllvm-rtdyld\b", 233 r"\bllvm-shlib\b", 234 r"\bllvm-size\b", 235 r"\bllvm-tblgen\b", 236 r"\bllvm-c-test\b", 237 # Match llvmc but not -llvmc 238 NOHYPHEN + r"\bllvmc\b", 239 # Match lto but not -lto 240 NOHYPHEN + r"\blto\b", 241 r"\bmacho-dump\b", 242 # Don't match '.opt', '-opt', '^opt' or '/opt'. 243 r"(?<!\.|-|\^|/)\bopt\b", 244 r"\bFileCheck\b", 245 r"\bFileUpdate\b", 246 r"\bc-index-test\b", 247 r"\bfpcmp\b", 248 r"\bobj2yaml\b", 249 r"\byaml2obj\b", 250 # Handle these specially as they are strings searched 251 # for during testing. 252 r"\| \bcount\b", 253 r"\| \bnot\b"]: 254 # Extract the tool name from the pattern. This relies on the tool 255 # name being surrounded by \b word match operators. If the 256 # pattern starts with "| ", include it in the string to be 257 # substituted. 258 substitution = re.sub(r"^(\\)?((\| )?)\W+b([0-9A-Za-z-_]+)\\b\W*$", 259 r"\2" + llvm_tools_dir + "/" + r"\4", 260 pattern) 261 for ext in pathext: 262 substitution_ext = substitution + ext 263 if os.path.exists(substitution_ext): 264 substitution = substitution_ext 265 break 266 config.substitutions.append((pattern, substitution)) 267 268### Features 269 270# Shell execution 271if execute_external: 272 config.available_features.add('shell') 273 274# Others/can-execute.txt 275if sys.platform not in ['win32']: 276 config.available_features.add('can-execute') 277 278# Loadable module 279# FIXME: This should be supplied by Makefile or autoconf. 280if sys.platform in ['win32', 'cygwin']: 281 loadable_module = (config.enable_shared == 1) 282else: 283 loadable_module = True 284 285if loadable_module: 286 config.available_features.add('loadable_module') 287 288# Sanitizers. 289if config.llvm_use_sanitizer == "Address": 290 config.available_features.add("asan") 291if (config.llvm_use_sanitizer == "Memory" or 292 config.llvm_use_sanitizer == "MemoryWithOrigins"): 293 config.available_features.add("msan") 294 295# Direct object generation 296if not 'hexagon' in config.target_triple: 297 config.available_features.add("object-emission") 298 299if config.have_zlib == "1": 300 config.available_features.add("zlib") 301 302# Native compilation: host arch == target arch 303# FIXME: Consider cases that target can be executed 304# even if host_triple were different from target_triple. 305if config.host_triple == config.target_triple: 306 config.available_features.add("native") 307 308# llc knows whether he is compiled with -DNDEBUG. 309import subprocess 310try: 311 llc_cmd = subprocess.Popen([os.path.join(llvm_tools_dir, 'llc'), '-version'], 312 stdout = subprocess.PIPE) 313except OSError: 314 print("Could not find llc in " + llvm_tools_dir) 315 exit(42) 316 317if re.search(r'with assertions', llc_cmd.stdout.read().decode('ascii')): 318 config.available_features.add('asserts') 319llc_cmd.wait() 320 321if 'darwin' == sys.platform: 322 try: 323 sysctl_cmd = subprocess.Popen(['sysctl', 'hw.optional.fma'], 324 stdout = subprocess.PIPE) 325 except OSError: 326 print("Could not exec sysctl") 327 result = sysctl_cmd.stdout.read().decode('ascii') 328 if -1 != result.find("hw.optional.fma: 1"): 329 config.available_features.add('fma3') 330 sysctl_cmd.wait() 331 332# Check if we should use gmalloc. 333use_gmalloc_str = lit_config.params.get('use_gmalloc', None) 334if use_gmalloc_str is not None: 335 if use_gmalloc_str.lower() in ('1', 'true'): 336 use_gmalloc = True 337 elif use_gmalloc_str.lower() in ('', '0', 'false'): 338 use_gmalloc = False 339 else: 340 lit_config.fatal('user parameter use_gmalloc should be 0 or 1') 341else: 342 # Default to not using gmalloc 343 use_gmalloc = False 344 345# Allow use of an explicit path for gmalloc library. 346# Will default to '/usr/lib/libgmalloc.dylib' if not set. 347gmalloc_path_str = lit_config.params.get('gmalloc_path', 348 '/usr/lib/libgmalloc.dylib') 349 350if use_gmalloc: 351 config.environment.update({'DYLD_INSERT_LIBRARIES' : gmalloc_path_str}) 352