Skip to content

rtsan: Support free_sized and free_aligned_sized from C23 #145085

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
44 changes: 44 additions & 0 deletions compiler-rt/lib/rtsan/rtsan_interceptors_posix.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -869,6 +869,48 @@ INTERCEPTOR(void, free, void *ptr) {
return REAL(free)(ptr);
}

#if SANITIZER_INTERCEPT_FREE_SIZED
INTERCEPTOR(void, free_sized, void *ptr, SIZE_T size) {
if (DlsymAlloc::PointerIsMine(ptr))
return DlsymAlloc::Free(ptr);

// According to the C and C++ standard, freeing a nullptr is guaranteed to be
// a no-op (and thus real-time safe). This can be confirmed for looking at
// __libc_free in the glibc source.
if (ptr != nullptr)
__rtsan_notify_intercepted_call("free_sized");

if (REAL(free_sized))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you help me understand what the conditions would have to be to be in this interceptor, but not have the REAL free_sized available?

It seems like to be in this interceptor, the real one would have to exist

return REAL(free_sized)(ptr, size);
return REAL(free)(ptr);
}
#define RTSAN_MAYBE_INTERCEPT_FREE_SIZED INTERCEPT_FUNCTION(free_sized)
#else
#define RTSAN_MAYBE_INTERCEPT_FREE_SIZED
#endif

#if SANITIZER_INTERCEPT_FREE_ALIGNED_SIZED
INTERCEPTOR(void, free_aligned_sized, void *ptr, SIZE_T alignment,
SIZE_T size) {
if (DlsymAlloc::PointerIsMine(ptr))
return DlsymAlloc::Free(ptr);

// According to the C and C++ standard, freeing a nullptr is guaranteed to be
// a no-op (and thus real-time safe). This can be confirmed for looking at
// __libc_free in the glibc source.
if (ptr != nullptr)
__rtsan_notify_intercepted_call("free_aligned_sized");

if (REAL(free_aligned_sized))
return REAL(free_aligned_sized)(ptr, alignment, size);
return REAL(free)(ptr);
}
#define RTSAN_MAYBE_INTERCEPT_FREE_ALIGNED_SIZED \
INTERCEPT_FUNCTION(free_aligned_sized)
#else
#define RTSAN_MAYBE_INTERCEPT_FREE_ALIGNED_SIZED
#endif

INTERCEPTOR(void *, malloc, SIZE_T size) {
if (DlsymAlloc::Use())
return DlsymAlloc::Allocate(size);
Expand Down Expand Up @@ -1493,6 +1535,8 @@ INTERCEPTOR(INT_TYPE_SYSCALL, syscall, INT_TYPE_SYSCALL number, ...) {
void __rtsan::InitializeInterceptors() {
INTERCEPT_FUNCTION(calloc);
INTERCEPT_FUNCTION(free);
RTSAN_MAYBE_INTERCEPT_FREE_SIZED;
RTSAN_MAYBE_INTERCEPT_FREE_ALIGNED_SIZED;
INTERCEPT_FUNCTION(malloc);
INTERCEPT_FUNCTION(realloc);
INTERCEPT_FUNCTION(reallocf);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
// RUN: %clang -std=c23 -O0 %s -o %t && %run %t
// UNSUPPORTED: asan, hwasan, rtsan, ubsan
// UNSUPPORTED: asan, hwasan, ubsan

#include <stddef.h>
#include <stdlib.h>

#if defined(__has_feature) && __has_feature(realtime_sanitizer)
# include <sanitizer/rtsan_interface.h>
#endif

extern void *aligned_alloc(size_t alignment, size_t size);

extern void free_aligned_sized(void *p, size_t alignment, size_t size);

int main() {
#if defined(__has_feature) && __has_feature(realtime_sanitizer)
__rtsan_disable();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You shouldn't need to disable and re-enable here, be cause main isn't marked as nonblocking.

Can you share what happens when you omit these calls?

#endif
volatile void *p = aligned_alloc(128, 1024);
free_aligned_sized((void *)p, 128, 1024);
#if defined(__has_feature) && __has_feature(realtime_sanitizer)
__rtsan_enable();
#endif
return 0;
}
12 changes: 10 additions & 2 deletions compiler-rt/test/sanitizer_common/TestCases/Linux/free_sized.c
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
// RUN: %clang -std=c23 -O0 %s -o %t && %run %t
// UNSUPPORTED: asan, hwasan, rtsan, ubsan
// UNSUPPORTED: asan, hwasan, ubsan

#include <stddef.h>
#include <stdlib.h>

extern void *aligned_alloc(size_t alignment, size_t size);
#if defined(__has_feature) && __has_feature(realtime_sanitizer)
# include <sanitizer/rtsan_interface.h>
#endif

extern void free_sized(void *p, size_t size);

int main() {
#if defined(__has_feature) && __has_feature(realtime_sanitizer)
__rtsan_disable();
#endif
volatile void *p = malloc(64);
free_sized((void *)p, 64);
#if defined(__has_feature) && __has_feature(realtime_sanitizer)
__rtsan_enable();
#endif
return 0;
}
Loading