mirror of
https://github.com/llvm/llvm-project.git
synced 2025-04-25 09:26:07 +00:00
[lit] Raise the logic for enabling clang & lld substitutions to llvm.
This paves the way for other projects which might /use/ clang or lld but not necessarily need to the full set of functionality available to clang and lld tests to be able to have a basic set of substitutions that allow a project to run the clang or lld executables. llvm-svn: 315627
This commit is contained in:
Zachary Turner
parent
14cf51410b
commit
ad5997e87a
@ -39,71 +39,33 @@ 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?
|
||||
llvm_config.use_default_substitutions()
|
||||
|
||||
# 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)
|
||||
llvm_config.use_clang()
|
||||
|
||||
# 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.
|
||||
config.substitutions.append(('%PATH%', config.environment['PATH']))
|
||||
|
||||
|
||||
def inferClang(PATH):
|
||||
# Determine which clang to use.
|
||||
clang = os.getenv('CLANG')
|
||||
# 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]
|
||||
|
||||
# If the user set clang in the environment, definitely use that and don't
|
||||
# try to validate.
|
||||
if clang:
|
||||
return clang
|
||||
tools = [
|
||||
'c-index-test', 'clang-check', 'clang-diff', 'clang-format', 'opt',
|
||||
ToolSubst('%clang_func_map', command=FindTool(
|
||||
'clang-func-mapping'), unresolved='ignore'),
|
||||
]
|
||||
|
||||
# Otherwise look in the path.
|
||||
clang = lit.util.which('clang', PATH)
|
||||
if config.clang_examples:
|
||||
tools.append('clang-interpreter')
|
||||
|
||||
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)
|
||||
llvm_config.add_tool_substitutions(tools, tool_dirs)
|
||||
|
||||
# Plugins (loadable modules)
|
||||
# TODO: This should be supplied by Makefile or autoconf.
|
||||
@ -115,87 +77,6 @@ else:
|
||||
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 != '':
|
||||
@ -227,6 +108,8 @@ 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)
|
||||
|
||||
@ -10,7 +10,6 @@ import lit.formats
|
||||
import lit.util
|
||||
|
||||
from lit.llvm import llvm_config
|
||||
from lit.llvm.subst import ToolSubst
|
||||
|
||||
# Configuration file for the 'lit' test runner.
|
||||
|
||||
@ -36,28 +35,14 @@ config.test_source_root = os.path.dirname(__file__)
|
||||
|
||||
config.test_exec_root = os.path.join(config.lld_obj_root, 'test')
|
||||
|
||||
# Tweak the PATH to include the tools dir and the scripts dir.
|
||||
llvm_config.with_environment('PATH',
|
||||
[config.llvm_tools_dir, config.lld_tools_dir], append_path=True)
|
||||
|
||||
llvm_config.with_environment('LD_LIBRARY_PATH',
|
||||
[config.lld_libs_dir, config.llvm_libs_dir], append_path=True)
|
||||
|
||||
llvm_config.use_default_substitutions()
|
||||
|
||||
# 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.lld_tools_dir, config.llvm_tools_dir]
|
||||
llvm_config.use_lld()
|
||||
|
||||
tool_patterns = [
|
||||
ToolSubst('ld.lld', extra_args=['--full-shutdown']),
|
||||
'lld-link', 'llvm-as', 'llvm-mc', 'llvm-nm',
|
||||
'llvm-objdump', 'llvm-pdbutil', 'llvm-readobj', 'obj2yaml', 'yaml2obj',
|
||||
'lld']
|
||||
'llvm-as', 'llvm-mc', 'llvm-nm',
|
||||
'llvm-objdump', 'llvm-pdbutil', 'llvm-readobj', 'obj2yaml', 'yaml2obj']
|
||||
|
||||
llvm_config.add_tool_substitutions(tool_patterns, tool_dirs)
|
||||
llvm_config.add_tool_substitutions(tool_patterns)
|
||||
|
||||
# When running under valgrind, we mangle '-vg' onto the end of the triple so we
|
||||
# can check it with XFAIL and XTARGET.
|
||||
|
||||
@ -205,22 +205,24 @@ class LLVMConfig(object):
|
||||
def get_clang_has_lsan(self, clang, triple):
|
||||
if not clang:
|
||||
self.lit_config.warning(
|
||||
"config.host_cxx is unset but test suite is configured to use sanitizers.")
|
||||
'config.host_cxx is unset but test suite is configured to use sanitizers.')
|
||||
return False
|
||||
|
||||
clang_binary = clang.split()[0]
|
||||
version_string, _ = self.get_process_output([clang_binary, '--version'])
|
||||
version_string, _ = self.get_process_output(
|
||||
[clang_binary, '--version'])
|
||||
if not 'clang' in version_string:
|
||||
self.lit_config.warning(
|
||||
"compiler '%s' does not appear to be clang, " % clang_binary +
|
||||
"but test suite is configured to use sanitizers.")
|
||||
'but test suite is configured to use sanitizers.')
|
||||
return False
|
||||
|
||||
if re.match(r'.*-linux', triple):
|
||||
return True
|
||||
|
||||
if re.match(r'^x86_64.*-apple', triple):
|
||||
version_number = int(re.search(r'version ([0-9]+)\.', version_string).group(1))
|
||||
version_number = int(
|
||||
re.search(r'version ([0-9]+)\.', version_string).group(1))
|
||||
if 'Apple LLVM' in version_string:
|
||||
return version_number >= 9
|
||||
else:
|
||||
@ -299,3 +301,168 @@ class LLVMConfig(object):
|
||||
self.config.substitutions.append(('%python', sys.executable))
|
||||
self.add_tool_substitutions(
|
||||
tool_patterns, [self.config.llvm_tools_dir])
|
||||
|
||||
def use_llvm_tool(self, name, search_env=None, required=False, quiet=False):
|
||||
"""Find the executable program 'name', optionally using the specified
|
||||
environment variable as an override before searching the
|
||||
configuration's PATH."""
|
||||
# If the override is specified in the environment, use it without
|
||||
# validation.
|
||||
if search_env:
|
||||
tool = self.config.environment.get(search_env)
|
||||
if tool:
|
||||
return tool
|
||||
|
||||
# Otherwise look in the path.
|
||||
tool = lit.util.which(name, self.config.llvm_tools_dir)
|
||||
|
||||
if required and not tool:
|
||||
message = "couldn't find '{}' program".format(name)
|
||||
if search_env:
|
||||
message = message + \
|
||||
', try setting {} in your environment'.format(search_env)
|
||||
self.lit_config.fatal(message)
|
||||
|
||||
if tool:
|
||||
tool = os.path.normpath(tool)
|
||||
if not self.lit_config.quiet and not quiet:
|
||||
self.lit_config.note('using {}: {}'.format(name, tool))
|
||||
return tool
|
||||
|
||||
def use_clang(self, required=True):
|
||||
"""Configure the test suite to be able to invoke clang.
|
||||
|
||||
Sets up some environment variables important to clang, locates a
|
||||
just-built or installed clang, and add a set of standard
|
||||
substitutions useful to any test suite that makes use of clang.
|
||||
|
||||
"""
|
||||
# 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')
|
||||
|
||||
self.clear_environment(possibly_dangerous_env_vars)
|
||||
|
||||
# Tweak the PATH to include the tools dir and the scripts dir.
|
||||
paths = [self.config.llvm_tools_dir]
|
||||
tools = getattr(self.config, 'clang_tools_dir', None)
|
||||
if tools:
|
||||
paths = paths + [tools]
|
||||
self.with_environment('PATH', paths, append_path=True)
|
||||
|
||||
paths = [self.config.llvm_shlib_dir, self.config.llvm_libs_dir]
|
||||
self.with_environment('LD_LIBRARY_PATH', paths, append_path=True)
|
||||
|
||||
# Discover the 'clang' and 'clangcc' to use.
|
||||
|
||||
self.config.clang = self.use_llvm_tool(
|
||||
'clang', search_env='CLANG', required=required)
|
||||
|
||||
self.config.substitutions.append(
|
||||
('%llvmshlibdir', self.config.llvm_shlib_dir))
|
||||
self.config.substitutions.append(
|
||||
('%pluginext', self.config.llvm_plugin_ext))
|
||||
|
||||
builtin_include_dir = self.get_clang_builtin_include_dir(self.config.clang)
|
||||
tool_substitutions = [
|
||||
ToolSubst('%clang', command=self.config.clang),
|
||||
ToolSubst('%clang_analyze_cc1', command='%clang_cc1', extra_args=['-analyze']),
|
||||
ToolSubst('%clang_cc1', command=self.config.clang, extra_args=['-cc1', '-internal-isystem', builtin_include_dir, '-nostdsysteminc']),
|
||||
ToolSubst('%clang_cpp', command=self.config.clang, extra_args=['--driver-mode=cpp']),
|
||||
ToolSubst('%clang_cl', command=self.config.clang, extra_args=['--driver-mode=cl']),
|
||||
ToolSubst('%clangxx', command=self.config.clang, extra_args=['--driver-mode=g++']),
|
||||
]
|
||||
self.add_tool_substitutions(tool_substitutions)
|
||||
|
||||
self.config.substitutions.append(('%itanium_abi_triple',
|
||||
self.make_itanium_abi_triple(self.config.target_triple)))
|
||||
self.config.substitutions.append(('%ms_abi_triple',
|
||||
self.make_msabi_triple(self.config.target_triple)))
|
||||
self.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 self.config.host_triple and self.config.host_triple != '@LLVM_HOST_TRIPLE@':
|
||||
self.config.substitutions.append(('%target_itanium_abi_host_triple',
|
||||
'--target=%s' % self.make_itanium_abi_triple(self.config.host_triple)))
|
||||
else:
|
||||
self.config.substitutions.append(
|
||||
('%target_itanium_abi_host_triple', ''))
|
||||
|
||||
self.config.substitutions.append(
|
||||
('%src_include_dir', self.config.clang_src_dir + '/include'))
|
||||
|
||||
# FIXME: Find nicer way to prohibit this.
|
||||
self.config.substitutions.append(
|
||||
(' clang ', """*** Do not use 'clang' in tests, use '%clang'. ***"""))
|
||||
self.config.substitutions.append(
|
||||
(' clang\+\+ ', """*** Do not use 'clang++' in tests, use '%clangxx'. ***"""))
|
||||
self.config.substitutions.append(
|
||||
(' clang-cc ',
|
||||
"""*** Do not use 'clang-cc' in tests, use '%clang_cc1'. ***"""))
|
||||
self.config.substitutions.append(
|
||||
(' clang -cc1 -analyze ',
|
||||
"""*** Do not use 'clang -cc1 -analyze' in tests, use '%clang_analyze_cc1'. ***"""))
|
||||
self.config.substitutions.append(
|
||||
(' clang -cc1 ',
|
||||
"""*** Do not use 'clang -cc1' in tests, use '%clang_cc1'. ***"""))
|
||||
self.config.substitutions.append(
|
||||
(' %clang-cc1 ',
|
||||
"""*** invalid substitution, use '%clang_cc1'. ***"""))
|
||||
self.config.substitutions.append(
|
||||
(' %clang-cpp ',
|
||||
"""*** invalid substitution, use '%clang_cpp'. ***"""))
|
||||
self.config.substitutions.append(
|
||||
(' %clang-cl ',
|
||||
"""*** invalid substitution, use '%clang_cl'. ***"""))
|
||||
|
||||
def use_lld(self, required=True):
|
||||
"""Configure the test suite to be able to invoke lld.
|
||||
|
||||
Sets up some environment variables important to lld, locates a
|
||||
just-built or installed lld, and add a set of standard
|
||||
substitutions useful to any test suite that makes use of lld.
|
||||
|
||||
"""
|
||||
# Tweak the PATH to include the tools dir
|
||||
tool_dirs = [self.config.llvm_tools_dir]
|
||||
lib_dirs = [self.config.llvm_libs_dir]
|
||||
lld_tools_dir = getattr(self.config, 'lld_tools_dir', None)
|
||||
lld_libs_dir = getattr(self.config, 'lld_libs_dir', None)
|
||||
|
||||
if lld_tools_dir:
|
||||
tool_dirs = tool_dirs + [lld_tools_dir]
|
||||
if lld_libs_dir:
|
||||
lib_dirs = lib_dirs + [lld_libs_dir]
|
||||
|
||||
self.with_environment('PATH', tool_dirs, append_path=True)
|
||||
self.with_environment('LD_LIBRARY_PATH', lib_dirs, append_path=True)
|
||||
|
||||
self.config.substitutions.append(
|
||||
(r"\bld.lld\b", 'ld.lld --full-shutdown'))
|
||||
|
||||
tool_patterns = ['ld.lld', 'lld-link', 'lld']
|
||||
|
||||
self.add_tool_substitutions(tool_patterns, tool_dirs)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user