[sanitizer_common] Support stripping interceptor prefixes in RenderFrame()

[melver]

Summary

Rather than having every tool pass the right interceptor prefix, just
move this logic into RenderFrame().

Note that currently there are a few cases where due to aliasing the
intercepted function -> interceptor, the unwinder sees the intercepted
function - however this is never guaranteed. In a later change this
becomes more apparent, and other non-tsan sanitizer tests would fail as
well. By making the default RenderFrame() strip interceptor prefixes, we
don't rely on the linker aliasing preferences.

Depends on D151318

[dvyukov]

compiler-rt/lib/sanitizer_common/sanitizer_stacktrace_printer.cpp

36

Do we now pass custom prefix anywhere? Or is it only for tests?

[melver]

compiler-rt/lib/sanitizer_common/sanitizer_stacktrace_printer.cpp

36

Looks like it's only used in tests now. Should we just remove the argument completely?

[dvyukov]

compiler-rt/lib/sanitizer_common/sanitizer_stacktrace_printer.cpp

36

Yes, I think it's better to test actual production code.

[melver]

• Remove unused RenderFrame arg.
• Update test.

[melver]

• Fix formatting.

[MaskRay]

compiler-rt/lib/sanitizer_common/sanitizer_stacktrace_printer.cpp

22–38

Strip. Imperative sentences are common in llvm-project's comments.

[melver]

• Strips -> Strip

[thurston]

I think this patch (or one of your other ones submitted together) broke the buildbot - the change is good but a test needs updating:

e.g., https://lab.llvm.org/buildbot/#/builders/127/builds/48810 (all the changes are part of the same series):

C:/b/slave/sanitizer-windows/llvm-project/compiler-rt/lib/sanitizer_common/tests/sanitizer_stacktrace_printer_test.cpp:104
Expected equality of these values:
  "% Frame:42 PC:0x400000 Module:my/module ModuleOffset:0x200 " "Function:bar FunctionOffset:0x100 Source:my/source Line:10 " "Column:5"
    Which is: "% Frame:42 PC:0x400000 Module:my/module ModuleOffset:0x200 Function:bar FunctionOffset:0x100 Source:my/source Line:10 Column:5"
  str.data()
    Which is: "% Frame:42 PC:0x400000 Module:my/module ModuleOffset:0x200 Function:__asan_wrap_bar FunctionOffset:0x100 Source:my/source Line:10 Column:5"

[melver]

In D151319#4372543, @thurston wrote:

I think this patch (or one of your other ones submitted together) broke the buildbot - the change is good but a test needs updating:

e.g., https://lab.llvm.org/buildbot/#/builders/127/builds/48810 (all the changes are part of the same series):

C:/b/slave/sanitizer-windows/llvm-project/compiler-rt/lib/sanitizer_common/tests/sanitizer_stacktrace_printer_test.cpp:104
Expected equality of these values:
  "% Frame:42 PC:0x400000 Module:my/module ModuleOffset:0x200 " "Function:bar FunctionOffset:0x100 Source:my/source Line:10 " "Column:5"
    Which is: "% Frame:42 PC:0x400000 Module:my/module ModuleOffset:0x200 Function:bar FunctionOffset:0x100 Source:my/source Line:10 Column:5"
  str.data()
    Which is: "% Frame:42 PC:0x400000 Module:my/module ModuleOffset:0x200 Function:__asan_wrap_bar FunctionOffset:0x100 Source:my/source Line:10 Column:5"

This should already be fixed: https://github.com/llvm/llvm-project/commit/4c46c7cef3791a410cf226f7f005231be35dd8b9

[thurston]

This comment was removed by thurston.

[thurston]

I see, thanks Marco for the quick reply!

In D151319#4372568, @melver wrote:

In D151319#4372543, @thurston wrote:

I think this patch (or one of your other ones submitted together) broke the buildbot - the change is good but a test needs updating:

e.g., https://lab.llvm.org/buildbot/#/builders/127/builds/48810 (all the changes are part of the same series):

C:/b/slave/sanitizer-windows/llvm-project/compiler-rt/lib/sanitizer_common/tests/sanitizer_stacktrace_printer_test.cpp:104
Expected equality of these values:
  "% Frame:42 PC:0x400000 Module:my/module ModuleOffset:0x200 " "Function:bar FunctionOffset:0x100 Source:my/source Line:10 " "Column:5"
    Which is: "% Frame:42 PC:0x400000 Module:my/module ModuleOffset:0x200 Function:bar FunctionOffset:0x100 Source:my/source Line:10 Column:5"
  str.data()
    Which is: "% Frame:42 PC:0x400000 Module:my/module ModuleOffset:0x200 Function:__asan_wrap_bar FunctionOffset:0x100 Source:my/source Line:10 Column:5"

This should already be fixed: https://github.com/llvm/llvm-project/commit/4c46c7cef3791a410cf226f7f005231be35dd8b9

[gulfem]

We started seeing the following failure in our Clang Toolchain builders:

[1576/1617](6) Linking CXX shared library /b/s/w/ir/x/w/staging/llvm_build/lib/clang/17/lib/x86_64-unknown-fuchsia/libclang_rt.hwasan.so
FAILED: /b/s/w/ir/x/w/staging/llvm_build/lib/clang/17/lib/x86_64-unknown-fuchsia/libclang_rt.hwasan.so
ld.lld: error: undefined symbol: __sanitizer::RenderFrame(__sanitizer::InternalScopedString*, char const*, int, unsigned long, __sanitizer::AddressInfo const*, bool, char const*)

https://logs.chromium.org/logs/fuchsia/buildbucket/cr-buildbucket/8780110002348293249/+/u/clang/build/stdout

Here is our CMake commands:
https://logs.chromium.org/logs/fuchsia/buildbucket/cr-buildbucket/8780133481341449745/+/u/clang/configure/execution_details

[melver]

In D151319#4372921, @gulfem wrote:

We started seeing the following failure in our Clang Toolchain builders:

[1576/1617](6) Linking CXX shared library /b/s/w/ir/x/w/staging/llvm_build/lib/clang/17/lib/x86_64-unknown-fuchsia/libclang_rt.hwasan.so
FAILED: /b/s/w/ir/x/w/staging/llvm_build/lib/clang/17/lib/x86_64-unknown-fuchsia/libclang_rt.hwasan.so
ld.lld: error: undefined symbol: __sanitizer::RenderFrame(__sanitizer::InternalScopedString*, char const*, int, unsigned long, __sanitizer::AddressInfo const*, bool, char const*)

https://logs.chromium.org/logs/fuchsia/buildbucket/cr-buildbucket/8780110002348293249/+/u/clang/build/stdout

Here is our CMake commands:
https://logs.chromium.org/logs/fuchsia/buildbucket/cr-buildbucket/8780133481341449745/+/u/clang/configure/execution_details

Thanks for the report. This should be fixed now: https://reviews.llvm.org/rG150470a055d5

[gulfem]

In D151319#4373115, @melver wrote:

In D151319#4372921, @gulfem wrote:

We started seeing the following failure in our Clang Toolchain builders:

[1576/1617](6) Linking CXX shared library /b/s/w/ir/x/w/staging/llvm_build/lib/clang/17/lib/x86_64-unknown-fuchsia/libclang_rt.hwasan.so
FAILED: /b/s/w/ir/x/w/staging/llvm_build/lib/clang/17/lib/x86_64-unknown-fuchsia/libclang_rt.hwasan.so
ld.lld: error: undefined symbol: __sanitizer::RenderFrame(__sanitizer::InternalScopedString*, char const*, int, unsigned long, __sanitizer::AddressInfo const*, bool, char const*)

https://logs.chromium.org/logs/fuchsia/buildbucket/cr-buildbucket/8780110002348293249/+/u/clang/build/stdout

Here is our CMake commands:
https://logs.chromium.org/logs/fuchsia/buildbucket/cr-buildbucket/8780133481341449745/+/u/clang/configure/execution_details

Thanks for the report. This should be fixed now: https://reviews.llvm.org/rG150470a055d5

Thanks! I'm confirming that it fixed our issue.

compiler-rt/lib/sanitizer_common/sanitizer_stacktrace_printer.h

 // stack frame "frame_no" and appends it to the "buffer". "format" is a
 // string with placeholders, which is copied to the output with
 // placeholders substituted with the contents of "info". For example,
 // format string
 //   "  frame %n: function %F at %S"
 // will be turned into
 //   "  frame 10: function foo::bar() at my/file.cc:10"
 // You may additionally pass "strip_path_prefix" to strip prefixes of paths to
-// source files and modules, and "strip_func_prefix" to strip prefixes of
-// function names.
+// source files and modules.
 // Here's the full list of available placeholders:
 //   %% - represents a '%' character;
 //   %n - frame number (copy of frame_no);
 //   %p - PC in hex format;
 //   %m - path to module (binary or shared object);
 //   %o - offset in the module in hex format;
 //   %f - function name;
 //   %q - offset in the function in hex format (*if available*);
 //   %s - path to source file;
 //   %l - line in the source file;
 //   %c - column in the source file;
 //   %F - if function is known to be <foo>, prints "in <foo>", possibly
 //        followed by the offset in this function, but only if source file
 //        is unknown;
 //   %S - prints file/line/column information;
 //   %L - prints location information: file/line/column, if it is known, or
 //        module+offset if it is known, or (<unknown module>) string.
 //   %M - prints module basename and offset, if it is known, or PC.
 void RenderFrame(InternalScopedString *buffer, const char *format, int frame_no,
                  uptr address, const AddressInfo *info, bool vs_style,
-                 const char *strip_path_prefix = "",
-                 const char *strip_func_prefix = "");
+                 const char *strip_path_prefix = "");
 
 bool RenderNeedsSymbolization(const char *format);
 
 void RenderSourceLocation(InternalScopedString *buffer, const char *file,
                           int line, int column, bool vs_style,
                           const char *strip_path_prefix);
 
 void RenderModuleLocation(InternalScopedString *buffer, const char *module,

compiler-rt/lib/sanitizer_common/sanitizer_stacktrace_printer.cpp

 #include "sanitizer_file.h"
 #include "sanitizer_fuchsia.h"
 
 namespace __sanitizer {
 
 // sanitizer_symbolizer_markup.cpp implements these differently.
 #if !SANITIZER_SYMBOLIZER_MARKUP
 
-static const char *StripFunctionName(const char *function, const char *prefix) {
-  if (!function) return nullptr;
-  if (!prefix) return function;
-  uptr prefix_len = internal_strlen(prefix);
-  if (0 == internal_strncmp(function, prefix, prefix_len))
+// Strip interceptor prefixes from function name.
+static const char *StripFunctionName(const char *function) {
+  if (!function)
+    return nullptr;
+  auto try_strip = [function](const char *prefix) -> const char * {
+    const uptr prefix_len = internal_strlen(prefix);
+    if (!internal_strncmp(function, prefix, prefix_len))
       return function + prefix_len;
+    return nullptr;
+  };
+  if (SANITIZER_APPLE) {
+    if (const char *s = try_strip("wrap_"))
+      return s;
+  } else {
+    if (const char *s = try_strip("__interceptor_"))
+      return s;
+  }
   return function;
 }
 
 static const char *DemangleFunctionName(const char *function) {
   if (!function) return nullptr;
 
   // NetBSD uses indirection for old threading functions for historical reasons
   // The mangled names are internal implementation detail and should not be
if (info.uuid_size) {
     buffer->append(")");
   }
 }
 
 static const char kDefaultFormat[] = "    #%n %p %F %L";
 
 void RenderFrame(InternalScopedString *buffer, const char *format, int frame_no,
                  uptr address, const AddressInfo *info, bool vs_style,
-                 const char *strip_path_prefix, const char *strip_func_prefix) {
+                 const char *strip_path_prefix) {
   // info will be null in the case where symbolization is not needed for the
   // given format. This ensures that the code below will get a hard failure
   // rather than print incorrect information in case RenderNeedsSymbolization
   // ever ends up out of sync with this function. If non-null, the addresses
   // should match.
   CHECK(!info || address == info->address);
   if (0 == internal_strcmp(format, "DEFAULT"))
     format = kDefaultFormat;
case 'm':
       break;
     case 'o':
       buffer->append("0x%zx", info->module_offset);
       break;
     case 'b':
       MaybeBuildIdToBuffer(*info, /*PrefixSpace=*/false, buffer);
       break;
     case 'f':
-      buffer->append("%s", DemangleFunctionName(StripFunctionName(
-                               info->function, strip_func_prefix)));
+      buffer->append("%s",
+                     DemangleFunctionName(StripFunctionName(info->function)));
       break;
     case 'q':
       buffer->append("0x%zx", info->function_offset != AddressInfo::kUnknown
                                   ? info->function_offset
                                   : 0x0);
       break;
     case 's':
       buffer->append("%s", StripPathPrefix(info->file, strip_path_prefix));
       break;
     case 'l':
       buffer->append("%d", info->line);
       break;
     case 'c':
       buffer->append("%d", info->column);
       break;
     // Smarter special cases.
     case 'F':
       // Function name and offset, if file is unknown.
       if (info->function) {
-        buffer->append("in %s", DemangleFunctionName(StripFunctionName(
-                                    info->function, strip_func_prefix)));
+        buffer->append("in %s",
+                       DemangleFunctionName(StripFunctionName(info->function)));
         if (!info->file && info->function_offset != AddressInfo::kUnknown)
           buffer->append("+0x%zx", info->function_offset);
       }
       break;
     case 'S':
       // File/line information.
       RenderSourceLocation(buffer, info->file, info->line, info->column,
                            vs_style, strip_path_prefix);

compiler-rt/lib/sanitizer_common/tests/sanitizer_stacktrace_printer_test.cpp

 //===-- sanitizer_common_printer_test.cpp ---------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 //
 // This file is a part of sanitizer_common test suite.
 //
 //===----------------------------------------------------------------------===//
 #include "sanitizer_common/sanitizer_stacktrace_printer.h"
 
 #include "gtest/gtest.h"
+#include "interception/interception.h"
 
 namespace __sanitizer {
 
 TEST(SanitizerStacktracePrinter, RenderSourceLocation) {
   InternalScopedString str;
   RenderSourceLocation(&str, "/dir/file.cc", 10, 5, false, "");
   EXPECT_STREQ("/dir/file.cc:10:5", str.data());
 

 }
 
 TEST(SanitizerStacktracePrinter, RenderFrame) {
   int frame_no = 42;
   AddressInfo info;
   info.address = 0x400000;
   info.module = internal_strdup("/path/to/my/module");
   info.module_offset = 0x200;
-  info.function = internal_strdup("function_foo");
+  info.function = internal_strdup("foo");
   info.function_offset = 0x100;
   info.file = internal_strdup("/path/to/my/source");
   info.line = 10;
   info.column = 5;
   InternalScopedString str;
 
   // Dump all the AddressInfo fields.
   RenderFrame(&str,
               "%% Frame:%n PC:%p Module:%m ModuleOffset:%o "
               "Function:%f FunctionOffset:%q Source:%s Line:%l "
               "Column:%c",
-              frame_no, info.address, &info, false, "/path/to/", "function_");
+              frame_no, info.address, &info, false, "/path/to/");
   EXPECT_STREQ("% Frame:42 PC:0x400000 Module:my/module ModuleOffset:0x200 "
                "Function:foo FunctionOffset:0x100 Source:my/source Line:10 "
                "Column:5",
                str.data());
+
+  str.clear();
+  // Check that RenderFrame() strips interceptor prefixes.
+  info.function = internal_strdup(SANITIZER_STRINGIFY(WRAP(bar)));
+  RenderFrame(&str,
+              "%% Frame:%n PC:%p Module:%m ModuleOffset:%o "
+              "Function:%f FunctionOffset:%q Source:%s Line:%l "
+              "Column:%c",
+              frame_no, info.address, &info, false, "/path/to/");
+  EXPECT_STREQ("% Frame:42 PC:0x400000 Module:my/module ModuleOffset:0x200 "
+               "Function:bar FunctionOffset:0x100 Source:my/source Line:10 "
+               "Column:5",
+               str.data());
   info.Clear();
   str.clear();
 
   // Test special format specifiers.
   info.address = 0x400000;
   RenderFrame(&str, "%M", frame_no, info.address, &info, false);
   EXPECT_NE(nullptr, internal_strstr(str.data(), "400000"));
   str.clear();

compiler-rt/lib/tsan/rtl/tsan_report.cpp

case ReportTypeErrnoInSignal:
       return "signal handler spoils errno";
     case ReportTypeDeadlock:
       return "lock-order-inversion (potential deadlock)";
     // No default case so compiler warns us if we miss one
   }
   UNREACHABLE("missing case");
 }
 
-#if SANITIZER_APPLE
-static const char *const kInterposedFunctionPrefix = "wrap_";
-#else
-static const char *const kInterposedFunctionPrefix = "__interceptor_";
-#endif
-
 void PrintStack(const ReportStack *ent) {
   if (ent == 0 || ent->frames == 0) {
     Printf("    [failed to restore the stack]\n\n");
     return;
   }
   SymbolizedStack *frame = ent->frames;
   for (int i = 0; frame && frame->info.address; frame = frame->next, i++) {
     InternalScopedString res;
     RenderFrame(&res, common_flags()->stack_trace_format, i,
                 frame->info.address, &frame->info,
                 common_flags()->symbolize_vs_style,
-                common_flags()->strip_path_prefix, kInterposedFunctionPrefix);
+                common_flags()->strip_path_prefix);
     Printf("%s\n", res.data());
   }
   Printf("\n");
 }
 
 static void PrintMutexSet(Vector<ReportMopMutex> const& mset) {
   for (uptr i = 0; i < mset.Size(); i++) {
     if (i == 0)