GCCとClangの最近のバージョンは、ランタイムインストルメンテーションコードを追加するコンパイルフラグ(-fsanitize=undefined
)である未定義の動作サニタイザー(UBSan)を備えています。エラーの場合、次のような警告が表示されます。
packet-ber.c:1917:23:実行時エラー:54645397829836991の8桁の左シフトは、「long int」型では表現できません
これをデバッグして、上記の行でデバッグブレークを取得したいと思います。 Address Sanitizer(ASAN)の場合、ASAN_OPTIONS=abort_on_error=1
が発生し、致命的なエラーが発生してキャッチ可能になります。使用可能と思われる唯一のUBSanオプションは UBSAN_OPTIONS=print_stacktrace=1
で、レポートの呼び出しトレースダンプが生成されます。ただし、これではローカル変数を検査してからプログラムを続行できません。したがって、-fsanitize-undefined-trap-on-error
を使用することはできません。
UBSanレポートでgdbをどのように中断する必要がありますか? break __sanitizer::SharedPrintfCode
は機能しているようですが、名前はかなり内部的に見えます。
検出関数を壊す( @ Mark Plotnick および @ Iwillnotexist Idonotexist で説明)は1つのオプションですが、より良いアプローチは、検出後にこれらの問題を報告する関数を壊すことです。このアプローチは、__asan_report_error
で中断するASANにも使用されます。
概要:__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でも使用されます。以下のセクションのリンクは、compiler-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 %p\n",
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%s\n",
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
のソースコードを検索すると、関数 MaybePrintStackTrace が見つかります ScopedReportデストラクタ から呼び出されます。
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)Sanitizer関連のすべての関数を取得できます。
@Mark Plotnick 指摘 と同様に、これを行う方法は、UBSanのhandlersでブレークポイントを設定することです。
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
を見ると here で、コメントの完全なプレゼントを読むことができます。
// 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
here の他のヘッダーを調べることをお勧めします。そこにはたくさんのグッズがあります。
UBSanおよびASanのブレークポイントは、次のように追加できます。
(gdb) rbreak ^__ubsan_handle_ __asan_report_error
(gdb) commands
(gdb) finish
(gdb) end
これはハンドラでブレークポイントになり、直後にfinish
になります。これにより、レポートを印刷できますが、デバッガーは印刷された直後に制御を取得します。
__asan_report_error
に設定されたブレークポイントにヒットせず、デバッガーをトリガーせずに診断を出力した後にプログラムが存在します。診断を出力する前の__asan::ReportGenericError
と、診断の出力後の__sanitizer::Die
は asan wiki で説明されているようにヒットします。