mirror of
https://github.com/llvm/llvm-project.git
synced 2025-05-03 10:56:06 +00:00
96b04b68ed
This addresses two sources of inconsistency in test configuration
files.
1. Substitution boundaries. Previously you would specify a
substitution, such as 'lli', and then additionally a set
of characters that should fail to match before and after
the tool. This was used, for example, so that matches that
are parts of full paths would not be replaced. But not all
tools did this, and those that did would often re-invent
the set of characters themselves, leading to inconsistency.
Now, every tool substitution defaults to using a sane set
of reasonable defaults and you have to explicitly opt out
of it. This actually fixed a few latent bugs that were
never being surfaced, but only on accident.
2. There was no standard way for the system to decide how to
locate a tool. Sometimes you have an explicit path, sometimes
we would search for it and build up a path ourselves, and
sometimes we would build up a full command line. Furthermore,
there was no standardized way to handle missing tools. Do we
warn, fail, ignore, etc? All of this is now encapsulated in
the ToolSubst class. You either specify an exact command to
run, or an instance of FindTool('<tool-name>') and everything
else just works. Furthermore, you can specify an action to
take if the tool cannot be resolved.
Differential Revision: https://reviews.llvm.org/D38565
llvm-svn: 315085
300 lines
11 KiB
Python
300 lines
11 KiB
Python
# -*- Python -*-
|
|
|
|
import os
|
|
import platform
|
|
import re
|
|
import subprocess
|
|
import tempfile
|
|
|
|
import lit.formats
|
|
import lit.util
|
|
|
|
from lit.llvm import llvm_config
|
|
from lit.llvm.subst import ToolSubst
|
|
from lit.llvm.subst import FindTool
|
|
|
|
# Configuration file for the 'lit' test runner.
|
|
|
|
# name: The name of this test suite.
|
|
config.name = 'Clang'
|
|
|
|
# testFormat: The test format to use to interpret tests.
|
|
#
|
|
# For now we require '&&' between commands, until they get globally killed and
|
|
# the test runner updated.
|
|
config.test_format = lit.formats.ShTest(not llvm_config.use_lit_shell)
|
|
|
|
# suffixes: A list of file extensions to treat as test files.
|
|
config.suffixes = ['.c', '.cpp', '.cppm', '.m', '.mm', '.cu',
|
|
'.ll', '.cl', '.s', '.S', '.modulemap', '.test', '.rs']
|
|
|
|
# excludes: A list of directories to exclude from the testsuite. The 'Inputs'
|
|
# subdirectories contain auxiliary inputs for various tests in their parent
|
|
# directories.
|
|
config.excludes = ['Inputs', 'CMakeLists.txt', 'README.txt', 'LICENSE.txt']
|
|
|
|
# test_source_root: The root path where tests are located.
|
|
config.test_source_root = os.path.dirname(__file__)
|
|
|
|
# test_exec_root: The root path where tests should be run.
|
|
config.test_exec_root = os.path.join(config.clang_obj_root, 'test')
|
|
|
|
# Clear some environment variables that might affect Clang.
|
|
#
|
|
# This first set of vars are read by Clang, but shouldn't affect tests
|
|
# that aren't specifically looking for these features, or are required
|
|
# simply to run the tests at all.
|
|
#
|
|
# FIXME: Should we have a tool that enforces this?
|
|
|
|
# safe_env_vars = ('TMPDIR', 'TEMP', 'TMP', 'USERPROFILE', 'PWD',
|
|
# 'MACOSX_DEPLOYMENT_TARGET', 'IPHONEOS_DEPLOYMENT_TARGET',
|
|
# 'VCINSTALLDIR', 'VC100COMNTOOLS', 'VC90COMNTOOLS',
|
|
# 'VC80COMNTOOLS')
|
|
possibly_dangerous_env_vars = ['COMPILER_PATH', 'RC_DEBUG_OPTIONS',
|
|
'CINDEXTEST_PREAMBLE_FILE', 'LIBRARY_PATH',
|
|
'CPATH', 'C_INCLUDE_PATH', 'CPLUS_INCLUDE_PATH',
|
|
'OBJC_INCLUDE_PATH', 'OBJCPLUS_INCLUDE_PATH',
|
|
'LIBCLANG_TIMING', 'LIBCLANG_OBJTRACKING',
|
|
'LIBCLANG_LOGGING', 'LIBCLANG_BGPRIO_INDEX',
|
|
'LIBCLANG_BGPRIO_EDIT', 'LIBCLANG_NOTHREADS',
|
|
'LIBCLANG_RESOURCE_USAGE',
|
|
'LIBCLANG_CODE_COMPLETION_LOGGING']
|
|
# Clang/Win32 may refer to %INCLUDE%. vsvarsall.bat sets it.
|
|
if platform.system() != 'Windows':
|
|
possibly_dangerous_env_vars.append('INCLUDE')
|
|
|
|
llvm_config.clear_environment(possibly_dangerous_env_vars)
|
|
|
|
# Tweak the PATH to include the tools dir and the scripts dir.
|
|
llvm_config.with_environment(
|
|
'PATH', [config.llvm_tools_dir, config.clang_tools_dir], append_path=True)
|
|
|
|
llvm_config.with_environment('LD_LIBRARY_PATH', [
|
|
config.llvm_shlib_dir, config.llvm_libs_dir], append_path=True)
|
|
|
|
# Propagate path to symbolizer for ASan/MSan.
|
|
llvm_config.with_system_environment(
|
|
['ASAN_SYMBOLIZER_PATH', 'MSAN_SYMBOLIZER_PATH'])
|
|
|
|
llvm_config.use_default_substitutions()
|
|
|
|
# Discover the 'clang' and 'clangcc' to use.
|
|
|
|
|
|
def inferClang(PATH):
|
|
# Determine which clang to use.
|
|
clang = os.getenv('CLANG')
|
|
|
|
# If the user set clang in the environment, definitely use that and don't
|
|
# try to validate.
|
|
if clang:
|
|
return clang
|
|
|
|
# Otherwise look in the path.
|
|
clang = lit.util.which('clang', PATH)
|
|
|
|
if not clang:
|
|
lit_config.fatal("couldn't find 'clang' program, try setting "
|
|
'CLANG in your environment')
|
|
|
|
return clang
|
|
|
|
|
|
config.clang = inferClang(config.environment['PATH']).replace('\\', '/')
|
|
if not lit_config.quiet:
|
|
lit_config.note('using clang: %r' % config.clang)
|
|
|
|
# Plugins (loadable modules)
|
|
# TODO: This should be supplied by Makefile or autoconf.
|
|
if sys.platform in ['win32', 'cygwin']:
|
|
has_plugins = config.enable_shared
|
|
else:
|
|
has_plugins = True
|
|
|
|
if has_plugins and config.llvm_plugin_ext:
|
|
config.available_features.add('plugins')
|
|
|
|
config.substitutions.append(('%llvmshlibdir', config.llvm_shlib_dir))
|
|
config.substitutions.append(('%pluginext', config.llvm_plugin_ext))
|
|
config.substitutions.append(('%PATH%', config.environment['PATH']))
|
|
|
|
if config.clang_examples:
|
|
config.available_features.add('examples')
|
|
|
|
builtin_include_dir = llvm_config.get_clang_builtin_include_dir(config.clang)
|
|
|
|
tools = [
|
|
# By specifying %clang_cc1 as part of the substitution, this substitution
|
|
# relies on repeated substitution, so must come before %clang_cc1.
|
|
ToolSubst('%clang_analyze_cc1', command='%clang_cc1',
|
|
extra_args=['-analyze', '%analyze']),
|
|
ToolSubst('%clang_cc1', command=config.clang, extra_args=[
|
|
'-cc1', '-internal-isystem', builtin_include_dir, '-nostdsysteminc']),
|
|
ToolSubst('%clang_cpp', command=config.clang,
|
|
extra_args=['--driver-mode=cpp']),
|
|
ToolSubst('%clang_cl', command=config.clang,
|
|
extra_args=['--driver-mode=cl']),
|
|
ToolSubst('%clangxx', command=config.clang,
|
|
extra_args=['--driver-mode=g++']),
|
|
ToolSubst('%clang_func_map', command=FindTool(
|
|
'clang-func-mapping'), unresolved='ignore'),
|
|
ToolSubst('%clang', command=config.clang),
|
|
ToolSubst('%test_debuginfo', command=os.path.join(
|
|
config.llvm_src_root, 'utils', 'test_debuginfo.pl')),
|
|
'c-index-test', 'clang-check', 'clang-diff', 'clang-format', 'opt']
|
|
|
|
if config.clang_examples:
|
|
tools.append('clang-interpreter')
|
|
|
|
# For each occurrence of a clang tool name, replace it with the full path to
|
|
# the build directory holding that tool. We explicitly specify the directories
|
|
# to search to ensure that we get the tools just built and not some random
|
|
# tools that might happen to be in the user's PATH.
|
|
tool_dirs = [config.clang_tools_dir, config.llvm_tools_dir]
|
|
|
|
llvm_config.add_tool_substitutions(tools, tool_dirs)
|
|
|
|
# FIXME: Find nicer way to prohibit this.
|
|
config.substitutions.append(
|
|
(' clang ', """*** Do not use 'clang' in tests, use '%clang'. ***"""))
|
|
config.substitutions.append(
|
|
(' clang\+\+ ', """*** Do not use 'clang++' in tests, use '%clangxx'. ***"""))
|
|
config.substitutions.append(
|
|
(' clang-cc ',
|
|
"""*** Do not use 'clang-cc' in tests, use '%clang_cc1'. ***"""))
|
|
config.substitutions.append(
|
|
(' clang -cc1 -analyze ',
|
|
"""*** Do not use 'clang -cc1 -analyze' in tests, use '%clang_analyze_cc1'. ***"""))
|
|
config.substitutions.append(
|
|
(' clang -cc1 ',
|
|
"""*** Do not use 'clang -cc1' in tests, use '%clang_cc1'. ***"""))
|
|
config.substitutions.append(
|
|
(' %clang-cc1 ',
|
|
"""*** invalid substitution, use '%clang_cc1'. ***"""))
|
|
config.substitutions.append(
|
|
(' %clang-cpp ',
|
|
"""*** invalid substitution, use '%clang_cpp'. ***"""))
|
|
config.substitutions.append(
|
|
(' %clang-cl ',
|
|
"""*** invalid substitution, use '%clang_cl'. ***"""))
|
|
|
|
config.substitutions.append(('%itanium_abi_triple',
|
|
llvm_config.make_itanium_abi_triple(config.target_triple)))
|
|
config.substitutions.append(('%ms_abi_triple',
|
|
llvm_config.make_msabi_triple(config.target_triple)))
|
|
config.substitutions.append(('%resource_dir', builtin_include_dir))
|
|
|
|
# The host triple might not be set, at least if we're compiling clang from
|
|
# an already installed llvm.
|
|
if config.host_triple and config.host_triple != '@LLVM_HOST_TRIPLE@':
|
|
config.substitutions.append(('%target_itanium_abi_host_triple',
|
|
'--target=%s' % llvm_config.make_itanium_abi_triple(config.host_triple)))
|
|
else:
|
|
config.substitutions.append(('%target_itanium_abi_host_triple', ''))
|
|
|
|
config.substitutions.append(
|
|
('%src_include_dir', config.clang_src_dir + '/include'))
|
|
|
|
# Set available features we allow tests to conditionalize on.
|
|
#
|
|
if config.clang_default_cxx_stdlib != '':
|
|
config.available_features.add('default-cxx-stdlib-set')
|
|
|
|
# Enabled/disabled features
|
|
if config.clang_staticanalyzer:
|
|
config.available_features.add('staticanalyzer')
|
|
|
|
if config.clang_staticanalyzer_z3 == '1':
|
|
config.available_features.add('z3')
|
|
|
|
# As of 2011.08, crash-recovery tests still do not pass on FreeBSD.
|
|
if platform.system() not in ['FreeBSD']:
|
|
config.available_features.add('crash-recovery')
|
|
|
|
# ANSI escape sequences in non-dumb terminal
|
|
if platform.system() not in ['Windows']:
|
|
config.available_features.add('ansi-escape-sequences')
|
|
|
|
# Capability to print utf8 to the terminal.
|
|
# Windows expects codepage, unless Wide API.
|
|
if platform.system() not in ['Windows']:
|
|
config.available_features.add('utf8-capable-terminal')
|
|
|
|
# Support for libgcc runtime. Used to rule out tests that require
|
|
# clang to run with -rtlib=libgcc.
|
|
if platform.system() not in ['Darwin', 'Fuchsia']:
|
|
config.available_features.add('libgcc')
|
|
|
|
# Case-insensitive file system
|
|
def is_filesystem_case_insensitive():
|
|
handle, path = tempfile.mkstemp(
|
|
prefix='case-test', dir=config.test_exec_root)
|
|
isInsensitive = os.path.exists(
|
|
os.path.join(
|
|
os.path.dirname(path),
|
|
os.path.basename(path).upper()
|
|
))
|
|
os.close(handle)
|
|
os.remove(path)
|
|
return isInsensitive
|
|
|
|
|
|
if is_filesystem_case_insensitive():
|
|
config.available_features.add('case-insensitive-filesystem')
|
|
|
|
# Tests that require the /dev/fd filesystem.
|
|
if os.path.exists('/dev/fd/0') and sys.platform not in ['cygwin']:
|
|
config.available_features.add('dev-fd-fs')
|
|
|
|
# Not set on native MS environment.
|
|
if not re.match(r'.*-win32$', config.target_triple):
|
|
config.available_features.add('non-ms-sdk')
|
|
|
|
# Not set on native PS4 environment.
|
|
if not re.match(r'.*-scei-ps4', config.target_triple):
|
|
config.available_features.add('non-ps4-sdk')
|
|
|
|
# [PR8833] LLP64-incompatible tests
|
|
if not re.match(r'^x86_64.*-(win32|mingw32|windows-gnu)$', config.target_triple):
|
|
config.available_features.add('LP64')
|
|
|
|
# [PR12920] "clang-driver" -- set if gcc driver is not used.
|
|
if not re.match(r'.*-(cygwin)$', config.target_triple):
|
|
config.available_features.add('clang-driver')
|
|
|
|
# [PR18856] Depends to remove opened file. On win32, a file could be removed
|
|
# only if all handles were closed.
|
|
if platform.system() not in ['Windows']:
|
|
config.available_features.add('can-remove-opened-file')
|
|
|
|
|
|
def calculate_arch_features(arch_string):
|
|
features = []
|
|
for arch in arch_string.split():
|
|
features.append(arch.lower() + '-registered-target')
|
|
return features
|
|
|
|
|
|
llvm_config.feature_config(
|
|
[('--assertion-mode', {'ON': 'asserts'}),
|
|
('--cxxflags', {r'-D_GLIBCXX_DEBUG\b': 'libstdcxx-safe-mode'}),
|
|
('--targets-built', calculate_arch_features)
|
|
])
|
|
|
|
if lit.util.which('xmllint'):
|
|
config.available_features.add('xmllint')
|
|
|
|
if config.enable_backtrace:
|
|
config.available_features.add('backtrace')
|
|
|
|
# Check if we should allow outputs to console.
|
|
run_console_tests = int(lit_config.params.get('enable_console', '0'))
|
|
if run_console_tests != 0:
|
|
config.available_features.add('console')
|
|
|
|
lit.util.usePlatformSdkOnDarwin(config, lit_config)
|
|
macOSSDKVersion = lit.util.findPlatformSdkVersionOnMacOS(config, lit_config)
|
|
if macOSSDKVersion is not None:
|
|
config.available_features.add('macos-sdk-' + macOSSDKVersion)
|