[sanitizer] Fix suffix-log-path_test.c on arm-linux-gnu

[zatrazz]

Summary

The recent suffix-log-path_test.c checks for a full stacktrace and
since on some arm-linux-gnu configuration the slow unwinder is used
on default (when the compiler emits thumb code as default), it
requires -funwind-tables on tests.

It also seems to fix the issues disable by d025df3c1de.

[ostannard]

Could this also affect regular users of the sanitizers, or is it specific to the way we are running the tests? If it could affect users, then could we fix this in the clang driver, so that unwind tables are turned on by default whenever the sanitizers need them?

compiler-rt/test/sanitizer_common/CMakeLists.txt

82

Testing for Linux using NOT ANDROID AND NOT WINDOWS AND NOT APPLE will break if more operating systems are added in future, and it's not obvious to me that this list is complete now. This is tested with if("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux") elsewhere in compiler-rt, which looks like a better way to do this.

[zatrazz]

In D96337#2556270, @ostannard wrote:

Could this also affect regular users of the sanitizers, or is it specific to the way we are running the tests? If it could affect users, then could we fix this in the clang driver, so that unwind tables are turned on by default whenever the sanitizers need them?

I think it might affect regular uses on arm-linux-gnueabi, specially if they mix thumb generated object built gcc (which uses a slight different scheme to layout the FP than clang). However, I think it is a orthogonal issue, since compiler-rt can be built as a standalone library. I will work on adding this support on clang driver.

[zatrazz]

compiler-rt/test/sanitizer_common/CMakeLists.txt

82

Right, although this is not strickly required for Android (since it uses clang as base compiler and fast-unwinder works as expected).

[zatrazz]

Updated patch based on previous comments.

[ostannard]

LGTM

compiler-rt/test/lsan/TestCases/Linux/cleanup_in_tsd_destructor.c

 // Regression test for thread lifetime tracking. Thread data should be
 // considered live during the thread's termination, at least until the
 // user-installed TSD destructors have finished running (since they may contain
 // additional cleanup tasks). LSan doesn't actually meet that goal 100%, but it
 // makes its best effort.
 // RUN: LSAN_BASE="report_objects=1:use_registers=0:use_stacks=0"
 // RUN: %clang_lsan %s -o %t
 // RUN: %env_lsan_opts=$LSAN_BASE:use_tls=1 %run %t
 // RUN: %env_lsan_opts=$LSAN_BASE:use_tls=0 not %run %t 2>&1 | FileCheck %s
 
-// Investigate why it does not fail with use_stack=0
-// UNSUPPORTED: arm-linux || armhf-linux
-
 #include <assert.h>
 #include <pthread.h>
 #include <stdio.h>
 #include <stdlib.h>
 
 #include "sanitizer/lsan_interface.h"
 #include "sanitizer_common/print_address.h"
 

compiler-rt/test/lsan/TestCases/Linux/use_tls_pthread_specific_dynamic.cpp

 // Test that dynamically allocated thread-specific storage is included in the root set.
 // RUN: LSAN_BASE="report_objects=1:use_stacks=0:use_registers=0"
 // RUN: %clangxx_lsan %s -o %t
 // RUN: %env_lsan_opts=$LSAN_BASE:"use_tls=0" not %run %t 2>&1 | FileCheck %s
 // RUN: %env_lsan_opts=$LSAN_BASE:"use_tls=1" %run %t 2>&1
 // RUN: %env_lsan_opts="" %run %t 2>&1
 
-// Investigate why it does not fail with use_tls=0
-// UNSUPPORTED: arm-linux || armhf-linux
-
 #include <assert.h>
 #include <pthread.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include "sanitizer_common/print_address.h"
 
 // From glibc: this many keys are stored in the thread descriptor directly.
 const unsigned PTHREAD_KEY_2NDLEVEL_SIZE = 32;

compiler-rt/test/lsan/TestCases/disabler.c

 // Test for __lsan_disable() / __lsan_enable().
 // RUN: LSAN_BASE="report_objects=1:use_registers=0:use_stacks=0:use_tls=0"
 // RUN: %clang_lsan %s -o %t
 // RUN: %env_lsan_opts=$LSAN_BASE not %run %t 2>&1 | FileCheck %s
 
-// Investigate why it does not fail with use_stack=0
-// UNSUPPORTED: arm-linux || armhf-linux
-
 #include <stdio.h>
 #include <stdlib.h>
 
 #include "sanitizer/lsan_interface.h"
 
 int main() {
   void **p;
   {

compiler-rt/test/lsan/TestCases/do_leak_check_override.cpp

 // Test for __lsan_do_leak_check(). We test it by making the leak check run
 // before global destructors, which also tests compatibility with HeapChecker's
 // "normal" mode (LSan runs in "strict" mode by default).
 // RUN: LSAN_BASE="use_stacks=0:use_registers=0"
 // RUN: %clangxx_lsan %s -o %t
 // RUN: %env_lsan_opts=$LSAN_BASE not %run %t 2>&1 | FileCheck --check-prefix=CHECK-strict %s
 // RUN: %env_lsan_opts=$LSAN_BASE not %run %t foo 2>&1 | FileCheck --check-prefix=CHECK-normal %s
 
-// Investigate why LeakyGlobal leak does show
-// UNSUPPORTED: arm-linux || armhf-linux
-
 #include <stdio.h>
 #include <stdlib.h>
 #include <sanitizer/lsan_interface.h>
 
 struct LeakyGlobal {
   LeakyGlobal() {
     p = malloc(1337);
   }

compiler-rt/test/lsan/TestCases/ignore_object.c

 // Test for __lsan_ignore_object().
 // RUN: LSAN_BASE="report_objects=1:use_registers=0:use_stacks=0:use_tls=0"
 // RUN: %clang_lsan %s -o %t
 // RUN: %env_lsan_opts=$LSAN_BASE not %run %t 2>&1 | FileCheck %s
 
-// Investigate why it does not fail with use_stack=0
-// UNSUPPORTED: arm-linux || armhf-linux
-
 #include <stdio.h>
 #include <stdlib.h>
 
 #include "sanitizer/lsan_interface.h"
 
 int main() {
   // Explicitly ignored object.
   void **p = malloc(sizeof(void *));

compiler-rt/test/lsan/TestCases/use_after_return.cpp

 // Test that fake stack (introduced by ASan's use-after-return mode) is included
 // in the root set.
 // RUN: LSAN_BASE="report_objects=1:use_registers=0"
 // RUN: %clangxx_lsan %s -O2 -o %t
 // RUN: ASAN_OPTIONS=$ASAN_OPTIONS:detect_stack_use_after_return=1 %env_lsan_opts=$LSAN_BASE:"use_stacks=0" not %run %t 2>&1 | FileCheck %s
 // RUN: ASAN_OPTIONS=$ASAN_OPTIONS:detect_stack_use_after_return=1 %env_lsan_opts=$LSAN_BASE:"use_stacks=1" %run %t 2>&1
 // RUN: ASAN_OPTIONS=$ASAN_OPTIONS:detect_stack_use_after_return=1 %env_lsan_opts="" %run %t 2>&1
 
-// Investigate why it does not fail with use_stack=0
-// UNSUPPORTED: arm-linux || armhf-linux
-
 #include <stdio.h>
 #include <stdlib.h>
 #include "sanitizer_common/print_address.h"
 
 int main() {
   void *stack_var = malloc(1337);
   print_address("Test alloc: ", 1, stack_var);
   // Take pointer to variable, to ensure it's not optimized into a register.
   print_address("Stack var at: ", 1, &stack_var);
   // Do not return from main to prevent the pointer from going out of scope.
   exit(0);
 }
 // CHECK: Test alloc: [[ADDR:0x[0-9,a-f]+]]
 // CHECK: LeakSanitizer: detected memory leaks
 // CHECK: [[ADDR]] (1337 bytes)
 // CHECK: SUMMARY: {{(Leak|Address)}}Sanitizer:

compiler-rt/test/sanitizer_common/CMakeLists.txt

foreach(tool ${SUPPORTED_TOOLS})
 
   # TODO(dliew): We should iterate over the different
   # Apple platforms, not just macOS.
   foreach(arch ${TEST_ARCH})
     set(SANITIZER_COMMON_LIT_TEST_MODE ${tool})
     set(SANITIZER_COMMON_TEST_TARGET_ARCH ${arch})
     get_test_cc_for_arch(${arch} SANITIZER_COMMON_TEST_TARGET_CC SANITIZER_COMMON_TEST_TARGET_CFLAGS)
     set(CONFIG_NAME ${tool}-${arch}-${OS_NAME})
+
+    # ARM on Linux might use the slow unwinder as default and the unwind table is
+    # required to get a complete stacktrace.
+    if (${arch} MATCHES "armhf|arm" AND NOT ANDROID AND NOT WINDOWS AND NOT APPLE)
+      list(APPEND SANITIZER_COMMON_TEST_TARGET_CFLAGS -funwind-tables)
+      string(REPLACE ";" " " SANITIZER_COMMON_TEST_TARGET_CFLAGS
+                             "${SANITIZER_COMMON_TEST_TARGET_CFLAGS}")
+    endif()
+
     configure_lit_site_cfg(
       ${CMAKE_CURRENT_SOURCE_DIR}/lit.site.cfg.py.in
       ${CMAKE_CURRENT_BINARY_DIR}/${CONFIG_NAME}/lit.site.cfg.py)
     # FIXME(dliew): LSan i386 on Darwin is completly broken right now.
     # so don't run the tests by default.
     if (NOT (CMAKE_SYSTEM_NAME MATCHES "Darwin" AND
              ${tool} STREQUAL "lsan" AND
              ${arch} STREQUAL "i386"))