Skip to content

Commit

Permalink
Fix flaky test: signal_in_mutex_lock.cpp (#92587)
Browse files Browse the repository at this point in the history
Fix flaky test: the spawned thread keeps spinning
on `sampler_mutex` which may be released before
the thread is terminated based on termination
ordering.

My understanding of C++ semantics are that the
program here is invalid: the destructors of global
variables are invoked at the time of program
termination, and it is the responsibility of the
program to ensure that invoking those destructors
is safe.

rdar://126768628
  • Loading branch information
yln authored May 17, 2024
1 parent af7467c commit 1a5bc7c
Showing 1 changed file with 20 additions and 12 deletions.
32 changes: 20 additions & 12 deletions compiler-rt/test/tsan/signal_in_mutex_lock.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
#include <signal.h>
#include <stdio.h>

#include <atomic>
#include <cassert>
#include <condition_variable>
#include <mutex>
Expand All @@ -13,9 +14,10 @@ std::mutex sampler_mutex; //dummy mutex to lock in the thread we spawn.
std::mutex done_mutex; // guards the cv and done variables.
std::condition_variable cv;
bool done = false;
std::atomic<bool> spin = true;

void *ThreadFunc(void *x) {
while (true) {
while (spin) {
// Lock the mutex
std::lock_guard<std::mutex> guard(sampler_mutex);
// Mutex is released at the end
Expand Down Expand Up @@ -51,20 +53,26 @@ int main() {
pthread_t thread;
pthread_create(&thread, NULL, ThreadFunc, NULL);

// Lock the mutex before sending the signal
std::lock_guard<std::mutex> guard(sampler_mutex);
// From now on thread 1 will be waiting for the lock
{
// Lock the mutex before sending the signal
std::lock_guard<std::mutex> guard(sampler_mutex);
// From now on thread 1 will be waiting for the lock

// Send the SIGPROF signal to thread.
int r = pthread_kill(thread, SIGPROF);
assert(r == 0);
// Send the SIGPROF signal to thread.
int r = pthread_kill(thread, SIGPROF);
assert(r == 0);

// Wait until signal handler sends the data.
std::unique_lock lk(done_mutex);
cv.wait(lk, [] { return done; });
// Wait until signal handler sends the data.
std::unique_lock lk(done_mutex);
cv.wait(lk, [] { return done; });

// We got the done variable from the signal handler. Exiting successfully.
fprintf(stderr, "PASS\n");
}

// We got the done variable from the signal handler. Exiting successfully.
fprintf(stderr, "PASS\n");
// Wait for thread to prevent it from spinning on a released mutex.
spin = false;
pthread_join(thread, nullptr);
}

// CHECK-NOT: WARNING: ThreadSanitizer:
Expand Down

0 comments on commit 1a5bc7c

Please sign in to comment.