llvm-project/libcxx/test/configs/apple-libc++-shared.cfg.in
Louis Dionne 719b2ac42e
[libc++] Allow testing Apple's system library as it is installed (#99086)
In order to test libc++ under the "Apple System Library" configuration,
we need to run the tests using DYLD_LIBRARY_PATH. This is required
because libc++ gets an install_name of /usr/lib when built as a system
library, which means that we must override the copy of libc++ used by
the whole process. This effectively reverts 2cf2f1b, which was the wrong
solution for the problem I was having.

Of course, this assumes that the just-built libc++ is sufficient to
replace the system library, which is not actually the case
out-of-the-box. Indeed, the system library contains a few symbols that
are not provided by the upstream library, leading to undefined symbols
when replacing the system library by the just-built one.

To solve this problem, we separately build shims that provide those
missing symbols and we manually link against them when we build
executables in the tests. While this is somewhat brittle, it provides a
localized and unintrusive way to allow testing the Apple system
configuration in an upstream environment, which has been a frequent
request.
2024-07-18 16:49:07 -04:00

52 lines
2.0 KiB
INI

# Testing configuration for Apple's system libc++.
#
# This configuration differs from a normal LLVM shared library configuration in
# that we must use DYLD_LIBRARY_PATH to run the tests against the just-built library,
# since Apple's libc++ has an absolute install_name.
#
# We also don't use a per-target include directory layout, so we have only one
# include directory for the libc++ headers.
#
# Finally, we also link against an artificial shims library that provides
# the functionality necessary for the upstream libc++ to be usable in place
# of a system-provided libc++. Without that, attempting to replace the system
# libc++ with DYLD_LIBRARY_PATH would result in missing symbols and other similar
# issues since the upstream libc++ does not contain all the symbols provided by
# the system library.
lit_config.load_config(config, '@CMAKE_CURRENT_BINARY_DIR@/cmake-bridge.cfg')
import os, site
site.addsitedir(os.path.join('@LIBCXX_SOURCE_DIR@', 'utils'))
import libcxx.test.params, libcxx.test.config, libcxx.test.dsl
ADDITIONAL_PARAMETERS = [
libcxx.test.dsl.Parameter(name='apple_system_shims', type=str,
actions=lambda path: [libcxx.test.dsl.AddSubstitution('%{apple-system-shims}', path)],
help="""
Path to a pre-built object file or static archive that contains shims necessary to
allow replacing the system libc++ by the just-built one.
"""),
]
config.substitutions.append(('%{flags}',
'-isysroot {}'.format('@CMAKE_OSX_SYSROOT@') if '@CMAKE_OSX_SYSROOT@' else ''
))
config.substitutions.append(('%{compile_flags}',
'-nostdinc++ -I %{include-dir} -I %{libcxx-dir}/test/support'
))
config.substitutions.append(('%{link_flags}',
'-nostdlib++ -L %{lib-dir} -lc++ %{apple-system-shims}'
))
config.substitutions.append(('%{exec}',
'%{executor} --execdir %T --env DYLD_LIBRARY_PATH=%{lib-dir} -- '
))
config.stdlib = 'apple-libc++'
libcxx.test.config.configure(
libcxx.test.params.DEFAULT_PARAMETERS + ADDITIONAL_PARAMETERS,
libcxx.test.features.DEFAULT_FEATURES,
config,
lit_config
)