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 ###
  99
 100 import os
 101
 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).
 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
 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) )
 158
 159 # Similarly, have a macro to use llc with DWARF even when the host is win32.
 160 llc_dwarf = 'llc'
 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) )
 164
 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'
 173 else:
 174     defaultIsMCJIT = 'false'
 175 config.substitutions.append( ('%defaultjit', '-use-mcjit='+defaultIsMCJIT) )
 176
 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'
 186   else:
 187     config.target_triple += jit_impl_cfg
 188
 189   config.substitutions.append( ('%lli', 'lli -use-mcjit') )
 190 else:
 191   config.substitutions.append( ('%lli', 'lli') )
 192
 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) )
 198
 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
 206 # Avoid matching RUN line fragments that are actually part of
 207 # path names or options or whatever.
 208 # The regex is a pre-assertion to avoid matching a preceding
 209 # dot, hyphen, carat, or slash (.foo, -foo, etc.).  Some patterns
 210 # also have a post-assertion to not match a trailing hyphen (foo-).
 211 NOJUNK = r"(?<!\.|-|\^|/)"
 212
 213 for pattern in [r"\bbugpoint\b(?!-)",
 214                 NOJUNK + r"\bclang\b(?!-)",
 215                 NOJUNK + r"\bllc\b",
 216                 r"\blli\b",
 217                 r"\bllvm-PerfectShuffle\b",
 218                 r"\bllvm-ar\b",
 219                 r"\bllvm-as\b",
 220                 r"\bllvm-bcanalyzer\b",
 221                 r"\bllvm-config\b",
 222                 r"\bllvm-cov\b",
 223                 r"\bllvm-diff\b",
 224                 r"\bllvm-dis\b",
 225                 r"\bllvm-dwarfdump\b",
 226                 r"\bllvm-extract\b",
 227                 r"\bllvm-link\b",
 228                 r"\bllvm-lto\b",
 229                 r"\bllvm-mc\b",
 230                 r"\bllvm-mcmarkup\b",
 231                 r"\bllvm-nm\b",
 232                 r"\bllvm-objdump\b",
 233                 r"\bllvm-profdata\b",
 234                 r"\bllvm-ranlib\b",
 235                 r"\bllvm-readobj\b",
 236                 r"\bllvm-rtdyld\b",
 237                 r"\bllvm-size\b",
 238                 r"\bllvm-tblgen\b",
 239                 r"\bllvm-c-test\b",
 240                 r"\bmacho-dump\b",
 241                 NOJUNK + r"\bopt\b",
 242                 r"\bFileCheck\b",
 243                 r"\bFileUpdate\b",
 244                 r"\bc-index-test\b",
 245                 r"\bfpcmp\b",
 246                 r"\bobj2yaml\b",
 247                 r"\byaml2obj\b",
 248                 # Handle these specially as they are strings searched
 249                 # for during testing.
 250                 r"\| \bcount\b",
 251                 r"\| \bnot\b"]:
 252     # Extract the tool name from the pattern.  This relies on the tool
 253     # name being surrounded by \b word match operators.  If the
 254     # pattern starts with "| ", include it in the string to be
 255     # substituted.
 256     tool_match = re.match(r"^(\\)?((\| )?)\W+b([0-9A-Za-z-_]+)\\b\W*$",
 257                           pattern)
 258     tool_pipe = tool_match.group(2)
 259     tool_name = tool_match.group(4)
 260     tool_path = lit.util.which(tool_name, llvm_tools_dir)
 261     if not tool_path:
 262         # Warn, but still provide a substitution.
 263         lit_config.note('Did not find ' + tool_name + ' in ' + llvm_tools_dir)
 264         tool_path = llvm_tools_dir + '/' + tool_name
 265     config.substitutions.append((pattern, tool_pipe + tool_path))
 266
 267 ### Features
 268
 269 # Shell execution
 270 if execute_external:
 271     config.available_features.add('shell')
 272
 273 # Others/can-execute.txt
 274 if sys.platform not in ['win32']:
 275     config.available_features.add('can-execute')
 276
 277 # Loadable module
 278 # FIXME: This should be supplied by Makefile or autoconf.
 279 if sys.platform in ['win32', 'cygwin']:
 280     loadable_module = (config.enable_shared == 1)
 281 else:
 282     loadable_module = True
 283
 284 if loadable_module:
 285     config.available_features.add('loadable_module')
 286
 287 # Sanitizers.
 288 if config.llvm_use_sanitizer == "Address":
 289     config.available_features.add("asan")
 290 if (config.llvm_use_sanitizer == "Memory" or
 291         config.llvm_use_sanitizer == "MemoryWithOrigins"):
 292     config.available_features.add("msan")
 293
 294 # Direct object generation
 295 if not 'hexagon' in config.target_triple:
 296     config.available_features.add("object-emission")
 297
 298 if config.have_zlib == "1":
 299     config.available_features.add("zlib")
 300 else:
 301     config.available_features.add("nozlib")
 302
 303 # Native compilation: host arch == target arch
 304 # FIXME: Consider cases that target can be executed
 305 # even if host_triple were different from target_triple.
 306 if config.host_triple == config.target_triple:
 307     config.available_features.add("native")
 308
 309 # Ask llvm-config about assertion mode.
 310 import subprocess
 311 try:
 312     llvm_config_cmd = subprocess.Popen(
 313         [os.path.join(llvm_tools_dir, 'llvm-config'), '--assertion-mode'],
 314         stdout = subprocess.PIPE)
 315 except OSError:
 316     print("Could not find llvm-config in " + llvm_tools_dir)
 317     exit(42)
 318
 319 if re.search(r'ON', llvm_config_cmd.stdout.read().decode('ascii')):
 320     config.available_features.add('asserts')
 321 llvm_config_cmd.wait()
 322
 323 if 'darwin' == sys.platform:
 324     try:
 325         sysctl_cmd = subprocess.Popen(['sysctl', 'hw.optional.fma'],
 326                                     stdout = subprocess.PIPE)
 327     except OSError:
 328         print("Could not exec sysctl")
 329     result = sysctl_cmd.stdout.read().decode('ascii')
 330     if -1 != result.find("hw.optional.fma: 1"):
 331         config.available_features.add('fma3')
 332     sysctl_cmd.wait()
 333
 334 # Check if we should use gmalloc.
 335 use_gmalloc_str = lit_config.params.get('use_gmalloc', None)
 336 if use_gmalloc_str is not None:
 337     if use_gmalloc_str.lower() in ('1', 'true'):
 338         use_gmalloc = True
 339     elif use_gmalloc_str.lower() in ('', '0', 'false'):
 340         use_gmalloc = False
 341     else:
 342         lit_config.fatal('user parameter use_gmalloc should be 0 or 1')
 343 else:
 344     # Default to not using gmalloc
 345     use_gmalloc = False
 346
 347 # Allow use of an explicit path for gmalloc library.
 348 # Will default to '/usr/lib/libgmalloc.dylib' if not set.
 349 gmalloc_path_str = lit_config.params.get('gmalloc_path',
 350                                          '/usr/lib/libgmalloc.dylib')
 351
 352 if use_gmalloc:
 353      config.environment.update({'DYLD_INSERT_LIBRARIES' : gmalloc_path_str})