c - 如何在 gdb 中中断 UBSan 报告并继续

Question

最新版本的GCC和Clang具有未定义的行为清理器（UBSan），这是一个添加运行时检测代码的编译标志（-fsanitize=undefined）。出现错误时，将显示如下警告：

packet-ber.c：1917：23：运行时错误：54645397829836991左移 8 位无法用类型"long int"表示

现在我想调试它并在上述行上获得调试中断。对于地址清理程序 （ASAN），存在ASAN_OPTIONS=abort_on_error=1，这会导致可捕获的致命错误。唯一可用的 UBSan 选项是 UBSAN_OPTIONS=print_stacktrace=1 这会导致报告的调用跟踪转储。但是，这不允许我检查局部变量然后继续程序。因此无法使用-fsanitize-undefined-trap-on-error。

我应该如何在瑞银报告上中断 gdb？虽然break __sanitizer::SharedPrintfCode似乎有效，但这个名字看起来很内在。

Answer 1

虽然中断检测功能（如@Mark Plotnick和@Iwillnotexist Idonotexist所述）是一种选择，但更好的方法是中断在检测到后报告这些问题的函数。这种方法也用于ASAN，其中人们会在__asan_report_error上中断。

摘要：您可以通过 __ubsan::ScopedReport::~ScopedReport 或 __ubsan::Diag::~Diag 上的断点在 ubsan 报表上停止。这些是私有的实现细节，将来可能会发生变化。使用 GCC 4.9、5.1.0、5.2.0 和 Clang 3.3、3.4、3.6.2 进行测试。

对于来自 ppa：ubuntu-toolchain-r/test 的 GCC 4.9.2，您需要libubsan0-dbg才能使上述断点可用。带有 Clang 3.3 和 3.4 的 Ubuntu 14.04 不支持__ubsan::ScopedReport::~ScopedReport断点，因此您只能在使用 __ubsan::Diag::~Diag 打印消息之前中断。

示例错误的源代码和 gdb 会话：

$ cat undef.c
int main(void) { return 1 << 1000; }
$ clang --version
clang version 3.6.2 (tags/RELEASE_362/final)
Target: x86_64-unknown-linux-gnu
Thread model: posix
$ clang -w -fsanitize=undefined undef.c -g
$ gdb -q -ex break __ubsan::ScopedReport::~ScopedReport -ex r ./a.out 
Reading symbols from ./a.out...done.
Breakpoint 1 at 0x428fb0
Starting program: ./a.out 
undef.c:1:27: runtime error: shift exponent 1000 is too large for 32-bit type 'int'
Breakpoint 1, 0x0000000000428fb0 in __ubsan::ScopedReport::~ScopedReport() ()
(gdb) bt
#0  0x0000000000428fb0 in __ubsan::ScopedReport::~ScopedReport() ()
#1  0x000000000042affb in handleShiftOutOfBoundsImpl(__ubsan::ShiftOutOfBoundsData*, unsigned long, unsigned long, __ubsan::ReportOptions) ()
#2  0x000000000042a952 in __ubsan_handle_shift_out_of_bounds ()
#3  0x000000000042d057 in main () at undef.c:1

---

详细分析如下。请注意，ASAN 和 ubsan 都源自 LLVM 项目，即 compiler-rt。这被Clang使用，最终也出现在GCC中。以下各节中的链接指向编译器 rt 项目代码 3.6 版。

ASAN 已将其内部__asan_report_error作为记录的公共接口的一部分。每当检测到违规时，都会调用此函数，其流在 lib/asan/asan_report.c：938 中继续：

void __asan_report_error(uptr pc, uptr bp, uptr sp, uptr addr, int is_write,
                         uptr access_size) {
  // Determine the error type.
  const char *bug_descr = "unknown-crash";
  ...
  ReportData report = { pc, sp, bp, addr, (bool)is_write, access_size,
                        bug_descr };
  ScopedInErrorReport in_report(&report);
  Decorator d;
  Printf("%s", d.Warning());
  Report("ERROR: AddressSanitizer: %s on address "
             "%p at pc %p bp %p sp %pn",
             bug_descr, (void*)addr, pc, bp, sp);
  Printf("%s", d.EndWarning());
  u32 curr_tid = GetCurrentTidOrInvalid();
  char tname[128];
  Printf("%s%s of size %zu at %p thread T%d%s%sn",
         d.Access(),
         access_size ? (is_write ? "WRITE" : "READ") : "ACCESS",
         access_size, (void*)addr, curr_tid,
         ThreadNameWithParenthesis(curr_tid, tname, sizeof(tname)),
         d.EndAccess());
  GET_STACK_TRACE_FATAL(pc, bp);
  stack.Print();
  DescribeAddress(addr, access_size);
  ReportErrorSummary(bug_descr, &stack);
  PrintShadowMemoryForAddress(addr);
}

另一方面，UBSAN没有公共接口，但其当前的实现也简单得多且有限（选项较少）。出现错误时，可以在设置UBSAN_OPTIONS=print_stacktrace=1环境变量时打印堆栈跟踪。因此，通过搜索源代码print_stacktrace，可以找到通过 ScopedReport 析构函数调用的函数 MaybePrintStackTrace：

ScopedReport::~ScopedReport() {
  MaybePrintStackTrace(Opts.pc, Opts.bp);
  MaybeReportErrorSummary(SummaryLoc);
  CommonSanitizerReportMutex.Unlock();
  if (Opts.DieAfterReport || flags()->halt_on_error)
    Die();
}

如您所见，有一种方法可以在出错时杀死程序，但不幸的是，没有内置机制来触发调试器陷阱。那么让我们找到一个合适的断点。

GDB 命令info functions <function name>可以将MaybePrintStackTrace标识为可以设置断点的函数。info functions ScopedReport::~ScopedReport的执行给出了另一个函数：__ubsan::ScopedReport::~ScopedReport 。如果这些函数似乎都不可用（即使安装了调试符号），则可以尝试info functions ubsan或info functions sanitizer以获取所有与 （UndefinedBehavior） 清理器相关的函数。

Answer 2

正如 Plotnick @Mark指出的那样，这样做的方法是在 UBSan 的处理程序处断点。

UBSan 有许多处理程序或魔术函数入口点，这些处理程序或魔术函数入口点是为未定义的行为调用的。编译器通过根据需要注入检查来检测代码;如果检查代码检测到 UB，它将调用这些处理程序。它们都以__ubsan_handle_开头，并在 libsanitizer/ubsan/ubsan_handlers.h 中定义。这是GCC ubsan_handlers.h副本的链接。

以下是 UBSan 标头的相关位（其中任何一个上的断点）：

#define UNRECOVERABLE(checkname, ...) 
  extern "C" SANITIZER_INTERFACE_ATTRIBUTE NORETURN 
    void __ubsan_handle_ ## checkname( __VA_ARGS__ );
#define RECOVERABLE(checkname, ...) 
  extern "C" SANITIZER_INTERFACE_ATTRIBUTE 
    void __ubsan_handle_ ## checkname( __VA_ARGS__ ); 
  extern "C" SANITIZER_INTERFACE_ATTRIBUTE NORETURN 
    void __ubsan_handle_ ## checkname ## _abort( __VA_ARGS__ );
/// brief Handle a runtime type check failure, caused by either a misaligned
/// pointer, a null pointer, or a pointer to insufficient storage for the
/// type.
RECOVERABLE(type_mismatch, TypeMismatchData *Data, ValueHandle Pointer)
/// brief Handle an integer addition overflow.
RECOVERABLE(add_overflow, OverflowData *Data, ValueHandle LHS, ValueHandle RHS)
/// brief Handle an integer subtraction overflow.
RECOVERABLE(sub_overflow, OverflowData *Data, ValueHandle LHS, ValueHandle RHS)
/// brief Handle an integer multiplication overflow.
RECOVERABLE(mul_overflow, OverflowData *Data, ValueHandle LHS, ValueHandle RHS)
/// brief Handle a signed integer overflow for a unary negate operator.
RECOVERABLE(negate_overflow, OverflowData *Data, ValueHandle OldVal)
/// brief Handle an INT_MIN/-1 overflow or division by zero.
RECOVERABLE(divrem_overflow, OverflowData *Data,
            ValueHandle LHS, ValueHandle RHS)
/// brief Handle a shift where the RHS is out of bounds or a left shift where
/// the LHS is negative or overflows.
RECOVERABLE(shift_out_of_bounds, ShiftOutOfBoundsData *Data,
            ValueHandle LHS, ValueHandle RHS)
/// brief Handle an array index out of bounds error.
RECOVERABLE(out_of_bounds, OutOfBoundsData *Data, ValueHandle Index)
/// brief Handle a __builtin_unreachable which is reached.
UNRECOVERABLE(builtin_unreachable, UnreachableData *Data)
/// brief Handle reaching the end of a value-returning function.
UNRECOVERABLE(missing_return, UnreachableData *Data)
/// brief Handle a VLA with a non-positive bound.
RECOVERABLE(vla_bound_not_positive, VLABoundData *Data, ValueHandle Bound)
/// brief Handle overflow in a conversion to or from a floating-point type.
RECOVERABLE(float_cast_overflow, FloatCastOverflowData *Data, ValueHandle From)
/// brief Handle a load of an invalid value for the type.
RECOVERABLE(load_invalid_value, InvalidValueData *Data, ValueHandle Val)
RECOVERABLE(function_type_mismatch,
            FunctionTypeMismatchData *Data,
            ValueHandle Val)
/// brief Handle returning null from function with returns_nonnull attribute.
RECOVERABLE(nonnull_return, NonNullReturnData *Data)
/// brief Handle passing null pointer to function with nonnull attribute.
RECOVERABLE(nonnull_arg, NonNullArgData *Data)

---

ASan甚至更容易。如果你看libsanitizer/include/sanitizer/asan_interface.h，你应该在这里浏览，你可以读到一个评论的死赠品：

  // This is an internal function that is called to report an error.
  // However it is still a part of the interface because users may want to
  // set a breakpoint on this function in a debugger.
  void __asan_report_error(void *pc, void *bp, void *sp,
                           void *addr, int is_write, size_t access_size);

此标头中的许多其他函数被显式注释为已公开，以便可从调试器调用。

我绝对建议您在这里探索libsanitizer/include/sanitizer的其他标题。那里有很多好吃的东西。

---

可以按如下方式添加 UBSan 和 ASan 的断点：

(gdb) rbreak ^__ubsan_handle_ __asan_report_error
(gdb) commands
(gdb) finish
(gdb) end

这将在处理程序上断点，并在之后立即finish断点。这允许打印报表，但调试器在打印报表后立即获得控制权。

Answer 3

设置为 __asan_report_error 的断点对我来说没有命中，程序在打印诊断程序后仅存在，没有调试器触发。 打印诊断程序之前__asan::ReportGenericError，打印诊断程序后__sanitizer::Die确实会受到攻击，如 ASAN Wiki 中所述。