Skip to content

[rtsan][NFC] Refactor where we unwind the stack #111443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 8, 2024
Merged

[rtsan][NFC] Refactor where we unwind the stack #111443

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0dce7ac
[rtsan][NFC] Refactor where we unwind the stack
cjappl Oct 7, 2024
d5949b0
[PR] fmayer - OnViolationAction->OnViolation
cjappl Oct 8, 2024
59b3385
[PR] fmayer - auto->void
cjappl Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 25 additions & 33 deletions compiler-rt/lib/rtsan/rtsan.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,41 +46,33 @@ static InitializationState GetInitializationState() {
atomic_load(&rtsan_initialized, memory_order_acquire));
}

static auto OnViolationAction(DiagnosticsInfo info) {
return [info]() {
IncrementTotalErrorCount();
static auto OnViolationAction(const BufferedStackTrace &stack,
const DiagnosticsInfo &info) {
IncrementTotalErrorCount();

BufferedStackTrace stack;
// If in the future we interop with other sanitizers, we will
// need to make our own stackdepot
StackDepotHandle handle = StackDepotPut_WithHandle(stack);

// We use the unwind_on_fatal flag here because of precedent with other
// sanitizers, this action is not necessarily fatal if halt_on_error=false
stack.Unwind(info.pc, info.bp, nullptr,
common_flags()->fast_unwind_on_fatal);
const bool is_stack_novel = handle.use_count() == 0;

// If in the future we interop with other sanitizers, we will
// need to make our own stackdepot
StackDepotHandle handle = StackDepotPut_WithHandle(stack);
// Marked UNLIKELY as if user is runing with halt_on_error=false
// we expect a high number of duplicate stacks. We are willing
// To pay for the first insertion.
if (UNLIKELY(is_stack_novel)) {
IncrementUniqueErrorCount();

const bool is_stack_novel = handle.use_count() == 0;
PrintDiagnostics(info);
stack.Print();

// Marked UNLIKELY as if user is runing with halt_on_error=false
// we expect a high number of duplicate stacks. We are willing
// To pay for the first insertion.
if (UNLIKELY(is_stack_novel)) {
IncrementUniqueErrorCount();
handle.inc_use_count_unsafe();
}

PrintDiagnostics(info);
stack.Print();

handle.inc_use_count_unsafe();
}

if (flags().halt_on_error) {
if (flags().print_stats_on_exit)
PrintStatisticsSummary();
Die();
}
};
if (flags().halt_on_error) {
if (flags().print_stats_on_exit)
PrintStatisticsSummary();
Die();
}
}

extern "C" {
Expand Down Expand Up @@ -141,17 +133,17 @@ __rtsan_notify_intercepted_call(const char *func_name) {
__rtsan_ensure_initialized();
GET_CALLER_PC_BP;
ExpectNotRealtime(GetContextForThisThread(),
OnViolationAction({DiagnosticsInfoType::InterceptedCall,
func_name, pc, bp}));
{DiagnosticsInfoType::InterceptedCall, func_name, pc, bp},
OnViolationAction);
}

SANITIZER_INTERFACE_ATTRIBUTE void
__rtsan_notify_blocking_call(const char *func_name) {
__rtsan_ensure_initialized();
GET_CALLER_PC_BP;
ExpectNotRealtime(GetContextForThisThread(),
OnViolationAction({DiagnosticsInfoType::BlockingCall,
func_name, pc, bp}));
{DiagnosticsInfoType::BlockingCall, func_name, pc, bp},
OnViolationAction);
}

} // extern "C"
16 changes: 14 additions & 2 deletions compiler-rt/lib/rtsan/rtsan_assertions.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,27 @@

#include "rtsan/rtsan.h"
#include "rtsan/rtsan_context.h"
#include "rtsan/rtsan_diagnostics.h"

#include "sanitizer_common/sanitizer_stacktrace.h"

namespace __rtsan {

template <typename OnViolationAction>
void ExpectNotRealtime(Context &context, OnViolationAction &&OnViolation) {
void ExpectNotRealtime(Context &context, const DiagnosticsInfo &info,
OnViolationAction &&OnViolation) {
CHECK(__rtsan_is_initialized());
if (context.InRealtimeContext() && !context.IsBypassed()) {
ScopedBypass sb{context};
OnViolation();

__sanitizer::BufferedStackTrace stack;

// We use the unwind_on_fatal flag here because of precedent with other
// sanitizers, this action is not necessarily fatal if halt_on_error=false
stack.Unwind(info.pc, info.bp, nullptr,
__sanitizer::common_flags()->fast_unwind_on_fatal);

OnViolation(stack, info);
}
}

Expand Down
10 changes: 8 additions & 2 deletions compiler-rt/lib/rtsan/tests/rtsan_test_assertions.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,11 @@

#include "rtsan/rtsan_assertions.h"

#include "sanitizer_common/sanitizer_stacktrace.h"

#include <gmock/gmock.h>

using namespace __sanitizer;
using namespace __rtsan;

class TestRtsanAssertions : public ::testing::Test {
Expand All @@ -25,9 +28,12 @@ class TestRtsanAssertions : public ::testing::Test {

static void ExpectViolationAction(Context &context,
bool expect_violation_callback) {
::testing::MockFunction<void()> mock_on_violation;
::testing::MockFunction<void(const BufferedStackTrace &stack,
const DiagnosticsInfo &info)>
mock_on_violation;
EXPECT_CALL(mock_on_violation, Call).Times(expect_violation_callback ? 1 : 0);
ExpectNotRealtime(context, mock_on_violation.AsStdFunction());
DiagnosticsInfo info{};
ExpectNotRealtime(context, info, mock_on_violation.AsStdFunction());
}

TEST_F(TestRtsanAssertions,
Expand Down
Loading