Skip to content
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

Relaxed exchange appears stronger than on real hardware #16

Open
snaury opened this issue Aug 30, 2023 · 3 comments
Open

Relaxed exchange appears stronger than on real hardware #16

snaury opened this issue Aug 30, 2023 · 3 comments

Comments

@snaury
Copy link

snaury commented Aug 30, 2023

I've been testing my data structures for correctness with relacy, and found an odd behavior where atomic.exchange(..., rl::memory_order_relaxed) appears to be stronger than expected. I then checked with real hardware (apple m1) and confirmed that it is indeed much weaker.

As far as I under the standard says this on the topic:

Atomic read-modify-write operations shall always read the last value (in the modification order) written before the write associated with the read-modify-write operation.

And relacy always returns the last written value. However it seems the last relaxed store is always considered the last value, where on real hardware (at least apple m1) it might get reordered with other stores and really happen later in the order.

Here's a minimal example test where relacy passes. Note how all atomic operations are relaxed:

check_relaxed_lock.cpp

#include <relacy/relacy.hpp>

struct test_relaxed_lock : rl::test_suite<test_relaxed_lock, 2> {
    rl::atomic<int> lock{ 0 };
    rl::atomic<int> counter{ 0 };

    void do_lock() {
        int current = 0;
        while (!lock.compare_exchange_weak(current, 1, rl::memory_order_relaxed)) {
            // spin waiting for the lock
            rl::yield(1, $);
            current = 0;
        }
    }

    void do_unlock() {
        lock.store(0, rl::memory_order_relaxed);
    }

    void thread(unsigned /*thread_index*/) {
        do_lock();
        // When the modification order of counter is considered this exchange
        // is not guaranteed to be before a store in another thread, however
        // by the time we unlock relacy has already stored the new value as
        // the "last value" and exchange loads that instead of some older
        // value. Real hardware behaves in a more relaxed way and store is
        // not always flushed before the exchange.
        int prev = counter.exchange(0, rl::memory_order_relaxed);
        counter.store(prev + 1, rl::memory_order_relaxed);
        do_unlock();
    }

    void after() {
        RL_ASSERT(lock($) == 0);
        RL_ASSERT(counter($) == params::thread_count);
    }
};

int main() {
    rl::test_params params;
    params.search_type = rl::sched_full;
    rl::simulate<test_relaxed_lock>(params);
}

And here's an example test that runs on real hardware and quickly fails, because counters don't match:

realcheck_relaxed_lock.cpp

#include <atomic>
#include <chrono>
#include <thread>
#include <cstdio>

template<class base>
class padded : public base {
public:
    using base::base;

private:
    char padding[256 - sizeof(base)];
};

struct test_relaxed {
    static constexpr size_t thread_count = 8;
    static constexpr int iterations_per_thread = 1000000/thread_count;

    padded<std::atomic<int>> ready;
    padded<std::atomic<int>> lock;
    padded<std::atomic<int>> counter;

    void enter_barrier() {
        ++ready;
        while (ready.load() != thread_count) {
            // spin
        }
    }

    void do_lock() {
        int current = 0;
        while (!lock.compare_exchange_weak(current, 1, std::memory_order_relaxed)) {
            asm volatile ("yield");
            current = 0;
        }
    }

    void do_unlock() {
        lock.store(0, std::memory_order_relaxed);
    }

    void do_once() {
        do_lock();
        // When the modification order of counter is considered this exchange
        // is not guaranteed to be before a store in another thread, and by
        // the we unlock it might not happen yet on real hardware (apple m1).
        // So this test exchanges some stale value to 0 and then the final
        // counter does not match.
        int prev = counter.exchange(0, std::memory_order_relaxed);
        counter.store(prev + 1, std::memory_order_relaxed);
        do_unlock();
    }

    void thread_func(size_t thread_index) {
        enter_barrier();
        for (int i = 0; i < iterations_per_thread; ++i) {
            do_once();
        }
    }

    void run() {
        ready.store(0);
        lock.store(0);
        counter.store(0);

        std::vector<std::thread> threads;
        threads.reserve(thread_count);
        for (size_t i = 0; i < thread_count; ++i) {
            threads.emplace_back([this, i]{ thread_func(i); });
        }
        for (auto& thread : threads) {
            thread.join();
        }

        int count = counter.load(std::memory_order_relaxed);
        if (count != iterations_per_thread * thread_count) {
            printf(" got counter=%d (expected %d)...",
                count, iterations_per_thread * thread_count);
            fflush(stdout);
            assert(false && "Iteration count did not match");
        }
    }
};

int main() {
    auto* t = new test_relaxed;
    for (int i = 0; ; ++i) {
        printf("Running iteration %d...", i);
        fflush(stdout);
        auto start = std::chrono::steady_clock::now();
        t->run();
        auto end = std::chrono::steady_clock::now();
        auto elapsed = end - start;
        printf(" done in %dms\n",
            (int)std::chrono::duration_cast<std::chrono::milliseconds>(elapsed).count());
    }
    delete t;
    return 0;
}

@ChrisMThomasson
Copy link

ChrisMThomasson commented Aug 30, 2023 via email

@dvyukov
Copy link
Owner

dvyukov commented Oct 4, 2023

Hi Aleksei,

You are right.
This is an inherent limitation with the current implementation approach. Relacy is not a formal model checker. It does dynamic verification based on actually observed executions. All operations, including atomic ones, are always executed in the actual program order (no relaxations).
For atomic loads we later can choose a "non-current" value to return (based on the memory model constraints):
https://github.com/dvyukov/relacy/blob/master/relacy/thread.hpp#L202-L260

However, for stores/rmw operations we cannot later easily change the execution order because modification order of atomic variables must be consistent for all threads and there may be threads that already observed original modification order. So for stores/rmw we simply always act on the latest value according to the program order:
https://github.com/dvyukov/relacy/blob/master/relacy/thread.hpp#L329

I think it may be possible to add at least some relaxations for store operations. Namely: if no threads have observed some last modifications, then potentially we can "insert" the current store somewhere in the past.
However, I am not sure this is possible for exchange/rmw operations, since any rmw operation also immediately observes the current modification order.

Just to manage expectations: the library is not actively maintained by me now. But if you will send a patch I will try to do my best to review it and merge.

@dvyukov
Copy link
Owner

dvyukov commented Oct 4, 2023

Btw, I used to converse with Dmitry Vyukov all the time over on comp.programming.threads. He is a friend.

Thanks, Chris :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants