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 # name: The name of this test suite.
  11 config.name = 'LLVM'
  12
  13 # Tweak PATH for Win32 to decide to use bash.exe or not.
  14 if sys.platform in ['win32']:
  15     # Seek sane tools in directories and set to $PATH.
  16     path = getattr(config, 'lit_tools_dir', None)
  17     path = lit.getToolsPath(path,
  18                             config.environment['PATH'],
  19                             ['cmp.exe', 'grep.exe', 'sed.exe'])
  20     if path is not None:
  21         path = os.path.pathsep.join((path,
  22                                      config.environment['PATH']))
  23         config.environment['PATH'] = path
  24
  25 # testFormat: The test format to use to interpret tests.
  26 execute_external = (not sys.platform in ['win32']
  27                     or lit.getBashPath() not in [None, ""])
  28 config.test_format = lit.formats.ShTest(execute_external)
  29
  30 # To ignore test output on stderr so it doesn't trigger failures uncomment this:
  31 #config.test_format = lit.formats.TclTest(ignoreStdErr=True)
  32
  33 # suffixes: A list of file extensions to treat as test files, this is actually
  34 # set by on_clone().
  35 config.suffixes = []
  36
  37 # excludes: A list of directories to exclude from the testsuite. The 'Inputs'
  38 # subdirectories contain auxiliary inputs for various tests in their parent
  39 # directories.
  40 config.excludes = ['Inputs']
  41
  42 # test_source_root: The root path where tests are located.
  43 config.test_source_root = os.path.dirname(__file__)
  44
  45 # test_exec_root: The root path where tests should be run.
  46 llvm_obj_root = getattr(config, 'llvm_obj_root', None)
  47 if llvm_obj_root is not None:
  48     config.test_exec_root = os.path.join(llvm_obj_root, 'test')
  49
  50 # Tweak the PATH to include the scripts dir, the tools dir, and the llvm-gcc bin
  51 # dir (if available).
  52 if llvm_obj_root is not None:
  53     llvm_src_root = getattr(config, 'llvm_src_root', None)
  54     if not llvm_src_root:
  55         lit.fatal('No LLVM source root set!')
  56     path = os.path.pathsep.join((os.path.join(llvm_src_root, 'test',
  57                                               'Scripts'),
  58                                  config.environment['PATH']))
  59     config.environment['PATH'] = path
  60
  61     llvm_tools_dir = getattr(config, 'llvm_tools_dir', None)
  62     if not llvm_tools_dir:
  63         lit.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.params.get('llvm_site_config', None)
 111     if site_cfg and os.path.exists(site_cfg):
 112         lit.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.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.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.fatal('No site specific configuration available!')
 140
 141     # Okay, that worked. Notify the user of the automagic, and reconfigure.
 142     lit.note('using out-of-tree build at %r' % llvm_obj_root)
 143     lit.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 # 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.
 162 if 'arm' in config.target_triple \
 163    or 'powerpc64' in config.target_triple:
 164     defaultIsMCJIT = 'true'
 165 else:
 166     defaultIsMCJIT = 'false'
 167 config.substitutions.append( ('%defaultjit', '-use-mcjit='+defaultIsMCJIT) )
 168
 169 # Process jit implementation option
 170 jit_impl_cfg = lit.params.get('jit_impl', None)
 171 if jit_impl_cfg == 'mcjit':
 172   # When running with mcjit, mangle -mcjit into target triple
 173   # and add -use-mcjit flag to lli invocation
 174   if 'i686' in config.target_triple:
 175     config.target_triple += jit_impl_cfg + '-ia32'
 176   elif 'x86_64' in config.target_triple:
 177     config.target_triple += jit_impl_cfg + '-ia64'
 178   else:
 179     config.target_triple += jit_impl_cfg
 180
 181   config.substitutions.append( ('%lli', 'lli -use-mcjit') )
 182 else:
 183   config.substitutions.append( ('%lli', 'lli') )
 184
 185 # Add site-specific substitutions.
 186 config.substitutions.append( ('%ocamlopt', config.ocamlopt_executable) )
 187 config.substitutions.append( ('%llvmshlibdir', config.llvm_shlib_dir) )
 188 config.substitutions.append( ('%shlibext', config.llvm_shlib_ext) )
 189
 190 # For each occurrence of an llvm tool name as its own word, replace it
 191 # with the full path to the build directory holding that tool.  This
 192 # ensures that we are testing the tools just built and not some random
 193 # tools that might happen to be in the user's PATH.  Thus this list
 194 # includes every tool placed in $(LLVM_OBJ_ROOT)/$(BuildMode)/bin
 195 # (llvm_tools_dir in lit parlance).
 196                 # Don't match 'bugpoint-' or 'clang-'.
 197                 # Don't match '/clang' or '-clang'.
 198 if os.pathsep == ';':
 199     pathext = os.environ.get('PATHEXT', '').split(';')
 200 else:
 201     pathext = ['']
 202 for pattern in [r"\bbugpoint\b(?!-)",   r"(?<!/|-)\bclang\b(?!-)",
 203                 r"\bgold\b",
 204                 r"\bllc\b",             r"\blli\b",
 205                 r"\bllvm-ar\b",         r"\bllvm-as\b",
 206                 r"\bllvm-bcanalyzer\b", r"\bllvm-config\b",
 207                 r"\bllvm-cov\b",        r"\bllvm-diff\b",
 208                 r"\bllvm-dis\b",        r"\bllvm-dwarfdump\b",
 209                 r"\bllvm-extract\b",    r"\bllvm-jistlistener\b",
 210                 r"\bllvm-link\b",       r"\bllvm-mc\b",
 211                 r"\bllvm-nm\b",         r"\bllvm-objdump\b",
 212                 r"\bllvm-prof\b",       r"\bllvm-ranlib\b",
 213                 r"\bllvm-rtdyld\b",     r"\bllvm-shlib\b",
 214                 r"\bllvm-size\b",
 215                 # Don't match '-llvmc'.
 216                 r"(?<!-)\bllvmc\b",     r"\blto\b",
 217                                         # Don't match '.opt', '-opt',
 218                                         # '^opt' or '/opt'.
 219                 r"\bmacho-dump\b",      r"(?<!\.|-|\^|/)\bopt\b",
 220                 r"\bllvm-tblgen\b",     r"\bFileCheck\b",
 221                 r"\bFileUpdate\b",      r"\bc-index-test\b",
 222                 r"\bfpcmp\b",           r"\bllvm-PerfectShuffle\b",
 223                 # Handle these specially as they are strings searched
 224                 # for during testing.
 225                 r"\| \bcount\b",         r"\| \bnot\b"]:
 226     # Extract the tool name from the pattern.  This relies on the tool
 227     # name being surrounded by \b word match operators.  If the
 228     # pattern starts with "| ", include it in the string to be
 229     # substituted.
 230     substitution = re.sub(r"^(\\)?((\| )?)\W+b([0-9A-Za-z-_]+)\\b\W*$",
 231                           r"\2" + llvm_tools_dir + "/" + r"\4",
 232                           pattern)
 233     for ext in pathext:
 234         substitution_ext = substitution + ext
 235         if os.path.exists(substitution_ext):
 236              substitution = substitution_ext
 237              break
 238     config.substitutions.append((pattern, substitution))
 239
 240 ### Features
 241
 242 # Shell execution
 243 if sys.platform not in ['win32'] or lit.getBashPath() != '':
 244     config.available_features.add('shell')
 245
 246 # Loadable module
 247 # FIXME: This should be supplied by Makefile or autoconf.
 248 if sys.platform in ['win32', 'cygwin']:
 249     loadable_module = (config.enable_shared == 1)
 250 else:
 251     loadable_module = True
 252
 253 if loadable_module:
 254     config.available_features.add('loadable_module')
 255
 256 # LTO on OS X
 257 if config.lto_is_enabled == "1" and platform.system() == "Darwin":
 258     config.available_features.add('lto_on_osx')
 259
 260 # Sanitizers.
 261 if config.llvm_use_sanitizer == "Address":
 262     config.available_features.add("asan")
 263 if (config.llvm_use_sanitizer == "Memory" or
 264         config.llvm_use_sanitizer == "MemoryWithOrigins"):
 265     config.available_features.add("msan")
 266
 267 # llc knows whether he is compiled with -DNDEBUG.
 268 import subprocess
 269 try:
 270     llc_cmd = subprocess.Popen([os.path.join(llvm_tools_dir, 'llc'), '-version'],
 271                            stdout = subprocess.PIPE)
 272 except OSError, why:
 273     print "Could not find llc in " + llvm_tools_dir
 274     exit(42)
 275
 276 if re.search(r'with assertions', llc_cmd.stdout.read()):
 277     config.available_features.add('asserts')
 278 llc_cmd.wait()