crown-engine/engine/core/thread/mutex.h

/*
Copyright (c) 2013 Daniele Bartolini, Michele Rossi
Copyright (c) 2012 Daniele Bartolini, Simone Boscaratto

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
*/

#pragma once

#include "config.h"
#include "types.h"
#include "assert.h"
#include "macros.h"

#if CROWN_PLATFORM_POSIX
	#include <pthread.h>
#elif CROWN_PLATFORM_WINDOWS
	#include "win_headers.h"
#endif

namespace crown
{

struct Mutex
{
	Mutex()
	{
#if CROWN_PLATFORM_POSIX
		int result = pthread_mutexattr_init(&m_attr);
		CE_ASSERT(result == 0, "pthread_mutexattr_init: errno = %d", result);
		result = pthread_mutexattr_settype(&m_attr, PTHREAD_MUTEX_ERRORCHECK);
		CE_ASSERT(result == 0, "pthread_mutexattr_settype: errno = %d", result);
		result = pthread_mutex_init(&m_mutex, &m_attr);
		CE_ASSERT(result == 0, "pthread_mutex_init: errno = %d", result);
		CE_UNUSED(result);
#elif CROWN_PLATFORM_WINDOWS
		InitializeCriticalSection(&m_cs);
#endif
	}

	~Mutex()
	{
#if CROWN_PLATFORM_POSIX
		int result = pthread_mutex_destroy(&m_mutex);
		CE_ASSERT(result == 0, "pthread_mutex_destroy: errno = %d", result);
		result = pthread_mutexattr_destroy(&m_attr);
		CE_ASSERT(result == 0, "pthread_mutexattr_destroy: errno = %d", result);
		CE_UNUSED(result);
#elif CROWN_PLATFORM_WINDOWS
		DeleteCriticalSection(&m_cs);
#endif

	}

	void lock()
	{
#if CROWN_PLATFORM_POSIX
		int result = pthread_mutex_lock(&m_mutex);
		CE_ASSERT(result == 0, "pthread_mutex_lock: errno = %d", result);
		CE_UNUSED(result);
#elif CROWN_PLATFORM_WINDOWS
		EnterCriticalSection(&m_cs);
#endif
	}

	void unlock()
	{
#if CROWN_PLATFORM_POSIX
		int result = pthread_mutex_unlock(&m_mutex);
		CE_ASSERT(result == 0, "pthread_mutex_unlock: errno = %d", result);
		CE_UNUSED(result);
#elif CROWN_PLATFORM_WINDOWS
		LeaveCriticalSection(&m_cs);
#endif
	}

public:

#if CROWN_PLATFORM_POSIX
	pthread_mutex_t m_mutex;
	pthread_mutexattr_t m_attr;
#elif CROWN_PLATFORM_WINDOWS
	CRITICAL_SECTION m_cs;
#endif

private:

	// Disable copying.
	Mutex(const Mutex&);
	Mutex& operator=(const Mutex&);
};

/// Automatically locks a mutex when created and unlocks when destroyed.
class ScopedMutex
{
public:

	/// Locks the given @a m mutex.
	ScopedMutex(Mutex& m)
		: m_mutex(m)
	{
		m_mutex.lock();
	}

	/// Unlocks the mutex passed to ScopedMutex::ScopedMutex()
	~ScopedMutex()
	{
		m_mutex.unlock();
	}

private:

	Mutex& m_mutex;

private:

	// Disable copying
	ScopedMutex(const ScopedMutex&);
	ScopedMutex& operator=(const ScopedMutex&);
};

} // namespace crown