Rack/include/mutex.hpp

#pragma once
#include <common.hpp>
#include <pthread.h>


namespace rack {


/** Allows multiple "reader" threads to obtain a lock simultaneously, but only one "writer" thread.

This implementation is currently just a wrapper for pthreads, which works on Linux/Mac/.
This is available in C++17 as std::shared_mutex, but unfortunately we're using C++11.

Locking should be avoided in real-time audio threads.
*/
struct SharedMutex {
	pthread_rwlock_t rwlock;

	SharedMutex() {
		int err = pthread_rwlock_init(&rwlock, NULL);
		(void) err;
		assert(!err);
	}
	~SharedMutex() {
		pthread_rwlock_destroy(&rwlock);
	}

	void lock() {
		int err = pthread_rwlock_wrlock(&rwlock);
		(void) err;
		assert(!err);
	}
	/** Returns whether the lock was acquired. */
	bool try_lock() {
		return pthread_rwlock_trywrlock(&rwlock) == 0;
	}
	void unlock() {
		int err = pthread_rwlock_unlock(&rwlock);
		(void) err;
		assert(!err);
	}

	void lock_shared() {
		int err = pthread_rwlock_rdlock(&rwlock);
		(void) err;
		assert(!err);
	}
	/** Returns whether the lock was acquired. */
	bool try_lock_shared() {
		return pthread_rwlock_tryrdlock(&rwlock) == 0;
	}
	void unlock_shared() {
		unlock();
	}
};


template <class TMutex>
struct SharedLock {
	TMutex& m;

	SharedLock(TMutex& m) : m(m) {
		m.lock_shared();
	}
	~SharedLock() {
		m.unlock_shared();
	}
};


} // namespace rack