light up UBSan for ARMv7

[garious]

Summary

You can expect UBSan to be built under any of the following conditions:

1) CMAKE_C_COMPILER is GCC built to cross-compile to ARM
2) CMAKE_C_COMPILER is Clang built to cross-compile to ARM (ARM is default target)
3) CMAKE_C_COMPILER is Clang and CMAKE_C_FLAGS contains -target and --sysroot

[garious]

+Richard

[garious]

Ping

[rsmith]

CMakeLists.txt

219 ↗

(On Diff #9458)

I don't understand what this change is doing: we don't want to run ARM tests if the native arch isn't ARM.

[rengolin]

CMakeLists.txt

219 ↗

(On Diff #9458)

yeah, it does look odd...

[garious]

CMakeLists.txt

219 ↗

(On Diff #9458)

The macro checks if CMAKE_C_COMPILER can target a particular architecture. If successful, it the build will generate a compiler-rt runtime with an ${arch} suffix.

Before this patch, we could only compile for ARM from a toolchain running on an ARM processor. With this patch, we can cross-compile if the combination "-march=armv7", CMAKE_C_COMPILER and CMAKE_CXX_FLAGS successfully links.

From the X86 build, this patch does nothing. From an ARM-only build, it generates only ARM runtime libraries.

Some examples:

Combinations that cause the ARM runtimes to be generated:
arm-linux-gnueabi-g++ -march=armv7 simple.cc
clang++ -march=armv7 -target arm-linux-gnueabi --sysroot=... -B... simple.cc

Combinations that do nothing:
Bad flag on X86: g++ -march=armv7 simple.cc
Wrong sysroot on X86: clang++ -march=armv7 simple.cc
Arch mismatch: aarch64-linux-gnu-g++ -march=armv7 simple.cc

[rengolin]

Right, I hadn't seen that. When using Phab, it's always good to do the diff -U99, so that you can get a larger context surrounding your code, so that we can easily see that it was inside an IF that was ARM specific. :)

[garious]

Extended this patch to include AArch64 and other compiler-rt libs that build on ARM.

Note that ASan does not include AArch64. Build error:

Objects of target "RTLSanCommon.aarch64" referenced but no such target exists.

Also, exactly half the UBSan test suite passes on AArch64. The other half depends on ASan being built.

[garious]

This fixes the caveats from the last version. UBSan now only tests in conjunction with ASan if ASan is supported. All ubsan, sanitizer_common and profile tests now pass on both armv7 and armv8.

ASan for AArch64 is not included because, although the library builds successfully and tests can be run (via qemu), the ASan runtime fails to initialize.

[garious]

Any objections? This patch only affects ARM builds.

[samsonov]

I'm OK with this change if it doesn't break arm-android.

[eugenis]

I don't think it will break android, but with cmake one never knows for sure.

[garious]

Closed by commit rL209835 (authored by @garious).

compiler-rt/trunk/CMakeLists.txt

 else()
   if("${LLVM_NATIVE_ARCH}" STREQUAL "X86")
     if (NOT MSVC)
       test_target_arch(x86_64 ${TARGET_64_BIT_CFLAGS})
     endif()
     test_target_arch(i386 ${TARGET_32_BIT_CFLAGS})
   elseif("${LLVM_NATIVE_ARCH}" STREQUAL "PowerPC")
     test_target_arch(powerpc64 ${TARGET_64_BIT_CFLAGS})
-  elseif("${LLVM_NATIVE_ARCH}" STREQUAL "ARM")
-    test_target_arch(arm "")
   endif()
+  test_target_arch(arm "-march=armv7-a")
+  test_target_arch(aarch64 "-march=armv8-a")
 endif()
 
 # We support running instrumented tests when we're not cross compiling
 # and target a UNIX-like system or Windows.
 # We can run tests on Android even when we are cross-compiling.
 if(("${CMAKE_HOST_SYSTEM}" STREQUAL "${CMAKE_SYSTEM}" AND (UNIX OR MSVC)) OR ANDROID
    OR COMPILER_RT_EMULATOR)
   option(COMPILER_RT_CAN_EXECUTE_TESTS "Can we execute instrumented tests" ON)
set(DARWIN_iossim_LINKFLAGS
     -Wl,-ios_simulator_version_min,7.0.0
     -mios-simulator-version-min=7.0
     -isysroot ${IOSSIM_SDK_DIR})
 endif()
 
 # Architectures supported by Sanitizer runtimes. Specific sanitizers may
 # support only subset of these (e.g. TSan works on x86_64 only).
 filter_available_targets(SANITIZER_COMMON_SUPPORTED_ARCH
-  x86_64 i386 powerpc64 arm)
-filter_available_targets(ASAN_SUPPORTED_ARCH x86_64 i386 powerpc64)
+  x86_64 i386 powerpc64 arm aarch64)
+filter_available_targets(ASAN_SUPPORTED_ARCH x86_64 i386 powerpc64 arm)
 filter_available_targets(DFSAN_SUPPORTED_ARCH x86_64)
 filter_available_targets(LSAN_SUPPORTED_ARCH x86_64)
 filter_available_targets(MSAN_SUPPORTED_ARCH x86_64)
-filter_available_targets(PROFILE_SUPPORTED_ARCH x86_64 i386 arm)
+filter_available_targets(PROFILE_SUPPORTED_ARCH x86_64 i386 arm aarch64)
 filter_available_targets(TSAN_SUPPORTED_ARCH x86_64)
-filter_available_targets(UBSAN_SUPPORTED_ARCH x86_64 i386)
+filter_available_targets(UBSAN_SUPPORTED_ARCH x86_64 i386 arm aarch64)
 
 add_subdirectory(include)
 
 set(COMPILER_RT_LIBCXX_PATH ${LLVM_MAIN_SRC_DIR}/projects/libcxx)
 if(EXISTS ${COMPILER_RT_LIBCXX_PATH}/)
   set(COMPILER_RT_HAS_LIBCXX_SOURCES TRUE)
 else()
   set(COMPILER_RT_HAS_LIBCXX_SOURCES FALSE)
 endif()
 
 add_subdirectory(lib)
 
 if(COMPILER_RT_INCLUDE_TESTS)
   add_subdirectory(unittests)
 endif()
 add_subdirectory(test)

compiler-rt/trunk/lib/lsan/CMakeLists.txt

set(LSAN_SOURCES
   lsan_preinit.cc
   lsan_thread.cc)
 
 set(LSAN_SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 
 # The common files need to build on every arch supported by ASan.
 # (Even if they build into dummy object files.)
 filter_available_targets(LSAN_COMMON_SUPPORTED_ARCH
-  x86_64 i386 powerpc64 arm)
+  x86_64 i386 powerpc64 arm aarch64)
 
 add_custom_target(lsan)
 
 if(APPLE)
   foreach(os ${SANITIZER_COMMON_SUPPORTED_DARWIN_OS})
     add_compiler_rt_darwin_object_library(RTLSanCommon ${os}
       ARCH ${LSAN_COMMON_SUPPORTED_ARCH}
       SOURCES ${LSAN_COMMON_SOURCES}

compiler-rt/trunk/test/asan/CMakeLists.txt

if(CAN_TARGET_arm)
   set(ASAN_TEST_DYNAMIC False)
   configure_lit_site_cfg(
     ${CMAKE_CURRENT_SOURCE_DIR}/lit.site.cfg.in
     ${CMAKE_CURRENT_BINARY_DIR}/ARMLinuxConfig/lit.site.cfg
     )
   list(APPEND ASAN_TESTSUITES ${CMAKE_CURRENT_BINARY_DIR}/ARMLinuxConfig)
 endif()
 
+if(CAN_TARGET_aarch64)
+  # This is only true if we are cross-compiling.
+  # Build all tests with host compiler and use host tools.
+  set(ASAN_TEST_TARGET_CC ${COMPILER_RT_TEST_COMPILER})
+  set(ASAN_TEST_TARGET_CFLAGS ${COMPILER_RT_TEST_COMPILER_CFLAGS})
+  set(ASAN_TEST_CONFIG_SUFFIX "-aarch64-linux")
+  set(ASAN_TEST_BITS "64")
+  set(ASAN_TEST_DYNAMIC False)
+  configure_lit_site_cfg(
+    ${CMAKE_CURRENT_SOURCE_DIR}/lit.site.cfg.in
+    ${CMAKE_CURRENT_BINARY_DIR}/AArch64LinuxConfig/lit.site.cfg
+    )
+  list(APPEND ASAN_TESTSUITES ${CMAKE_CURRENT_BINARY_DIR}/AArch64LinuxConfig)
+endif()
+
 if(CAN_TARGET_x86_64 OR CAN_TARGET_powerpc64)
   set(ASAN_TEST_CONFIG_SUFFIX "64")
   set(ASAN_TEST_BITS "64")
   set(ASAN_TEST_TARGET_CFLAGS ${TARGET_64_BIT_CFLAGS})
   set(ASAN_TEST_DYNAMIC False)
   configure_lit_site_cfg(
     ${CMAKE_CURRENT_SOURCE_DIR}/lit.site.cfg.in
     ${CMAKE_CURRENT_BINARY_DIR}/64bitConfig/lit.site.cfg

compiler-rt/trunk/test/ubsan/CMakeLists.txt

 set(UBSAN_LIT_TESTS_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 
 set(UBSAN_LIT_TEST_MODE "Standalone")
 configure_lit_site_cfg(
   ${CMAKE_CURRENT_SOURCE_DIR}/lit.site.cfg.in
   ${CMAKE_CURRENT_BINARY_DIR}/UbsanConfig/lit.site.cfg)
+set(UBSAN_TESTSUITES ${CMAKE_CURRENT_BINARY_DIR}/UbsanConfig)
 
+if(ASAN_SUPPORTED_ARCH)
   set(UBSAN_LIT_TEST_MODE "AddressSanitizer")
   configure_lit_site_cfg(
     ${CMAKE_CURRENT_SOURCE_DIR}/lit.site.cfg.in
     ${CMAKE_CURRENT_BINARY_DIR}/AsanConfig/lit.site.cfg)
+  list(APPEND UBSAN_TESTSUITES ${CMAKE_CURRENT_BINARY_DIR}/AsanConfig)
+endif()
 
 set(UBSAN_TEST_DEPS ${SANITIZER_COMMON_LIT_TEST_DEPS})
 if(NOT COMPILER_RT_STANDALONE_BUILD)
   list(APPEND UBSAN_TEST_DEPS ubsan asan)
 endif()
 
 add_lit_testsuite(check-ubsan "Running UndefinedBehaviorSanitizer tests"
-  ${CMAKE_CURRENT_BINARY_DIR}/UbsanConfig
-  ${CMAKE_CURRENT_BINARY_DIR}/AsanConfig
+  ${UBSAN_TESTSUITES}
   DEPENDS ${UBSAN_TEST_DEPS})
 set_target_properties(check-ubsan PROPERTIES FOLDER "UBSan unittests")