ladybird/Libraries/LibThreading/RWLock.h
Andreas Kling 656a84e180 LibThreading: Fix data race in RWLock::unlock()
The generic unlock() wrote to m_write_locked from every thread
regardless of whether a read or write lock was held. When multiple
threads held concurrent read locks, their unlock() calls would race
on the non-atomic m_write_locked and m_read_locked_with_write_lock
fields.

Split unlock() into unlock_read() and unlock_write() so that read
unlocks never touch the write-lock tracking fields. The RWLockLocker
template dispatches at compile time based on LockMode.
2026-03-07 13:09:50 +01:00

118 lines
2.1 KiB
C++

/*
* Copyright (c) 2024, Ali Mohammad Pur <mpfard@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Assertions.h>
#include <AK/Noncopyable.h>
#include <AK/Types.h>
#include <pthread.h>
namespace Threading {
class RWLock {
AK_MAKE_NONCOPYABLE(RWLock);
AK_MAKE_NONMOVABLE(RWLock);
public:
RWLock()
{
pthread_rwlock_init(&m_rwlock, nullptr);
}
~RWLock()
{
VERIFY(!m_write_locked);
pthread_rwlock_destroy(&m_rwlock);
}
void lock_read();
void lock_write();
void unlock_read();
void unlock_write();
private:
pthread_rwlock_t m_rwlock;
bool m_write_locked { false };
bool m_read_locked_with_write_lock { false };
};
enum class LockMode {
Read,
Write,
};
template<LockMode mode>
class RWLockLocker {
AK_MAKE_NONCOPYABLE(RWLockLocker);
AK_MAKE_NONMOVABLE(RWLockLocker);
public:
ALWAYS_INLINE explicit RWLockLocker(RWLock& l)
: m_lock(l)
{
lock();
}
ALWAYS_INLINE ~RWLockLocker()
{
unlock();
}
ALWAYS_INLINE void unlock()
{
if constexpr (mode == LockMode::Read)
m_lock.unlock_read();
else
m_lock.unlock_write();
}
ALWAYS_INLINE void lock()
{
if constexpr (mode == LockMode::Read)
m_lock.lock_read();
else
m_lock.lock_write();
}
private:
RWLock& m_lock;
};
ALWAYS_INLINE void RWLock::lock_read()
{
auto rc = pthread_rwlock_rdlock(&m_rwlock);
if (rc == EDEADLK) {
// We're already holding the write lock, so we can just return.
m_read_locked_with_write_lock = true;
} else {
VERIFY(rc == 0);
}
}
ALWAYS_INLINE void RWLock::lock_write()
{
auto rc = pthread_rwlock_wrlock(&m_rwlock);
VERIFY(rc == 0);
m_write_locked = true;
}
ALWAYS_INLINE void RWLock::unlock_read()
{
if (m_read_locked_with_write_lock) {
m_read_locked_with_write_lock = false;
return;
}
pthread_rwlock_unlock(&m_rwlock);
}
ALWAYS_INLINE void RWLock::unlock_write()
{
m_write_locked = false;
pthread_rwlock_unlock(&m_rwlock);
}
}