2014-05-21 07:03:45 +04:00
|
|
|
// Copyright 2014 Citra Emulator Project
|
2014-12-17 08:38:14 +03:00
|
|
|
// Licensed under GPLv2 or any later version
|
2014-11-19 11:49:13 +03:00
|
|
|
// Refer to the license.txt file included.
|
2014-05-21 07:03:45 +04:00
|
|
|
|
|
|
|
#include <map>
|
|
|
|
#include <vector>
|
|
|
|
|
|
|
|
#include "common/common.h"
|
|
|
|
|
|
|
|
#include "core/hle/kernel/kernel.h"
|
2014-05-30 07:31:01 +04:00
|
|
|
#include "core/hle/kernel/mutex.h"
|
2014-05-21 07:03:45 +04:00
|
|
|
#include "core/hle/kernel/thread.h"
|
|
|
|
|
|
|
|
namespace Kernel {
|
|
|
|
|
2015-01-15 03:22:50 +03:00
|
|
|
class Mutex : public WaitObject {
|
2014-05-21 07:03:45 +04:00
|
|
|
public:
|
2014-10-26 07:56:13 +03:00
|
|
|
std::string GetTypeName() const override { return "Mutex"; }
|
|
|
|
std::string GetName() const override { return name; }
|
2014-05-21 07:03:45 +04:00
|
|
|
|
2014-12-21 13:40:29 +03:00
|
|
|
static const HandleType HANDLE_TYPE = HandleType::Mutex;
|
|
|
|
HandleType GetHandleType() const override { return HANDLE_TYPE; }
|
2014-05-21 07:03:45 +04:00
|
|
|
|
|
|
|
bool initial_locked; ///< Initial lock state when mutex was created
|
|
|
|
bool locked; ///< Current locked state
|
|
|
|
Handle lock_thread; ///< Handle to thread that currently has mutex
|
2014-06-03 04:38:34 +04:00
|
|
|
std::string name; ///< Name of mutex (optional)
|
2015-01-18 23:45:01 +03:00
|
|
|
SharedPtr<Thread> current_thread; ///< Thread that has acquired the mutex
|
2014-05-27 05:01:27 +04:00
|
|
|
|
2015-01-18 21:25:51 +03:00
|
|
|
ResultVal<bool> Wait() override;
|
2015-01-18 06:23:49 +03:00
|
|
|
ResultVal<bool> Acquire() override;
|
2014-05-21 07:03:45 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
typedef std::multimap<Handle, Handle> MutexMap;
|
|
|
|
static MutexMap g_mutex_held_locks;
|
|
|
|
|
2014-12-07 23:44:21 +03:00
|
|
|
/**
|
|
|
|
* Acquires the specified mutex for the specified thread
|
|
|
|
* @param mutex Mutex that is to be acquired
|
|
|
|
* @param thread Thread that will acquired
|
|
|
|
*/
|
2014-12-22 16:07:22 +03:00
|
|
|
void MutexAcquireLock(Mutex* mutex, Handle thread = GetCurrentThread()->GetHandle()) {
|
2014-05-21 07:03:45 +04:00
|
|
|
g_mutex_held_locks.insert(std::make_pair(thread, mutex->GetHandle()));
|
|
|
|
mutex->lock_thread = thread;
|
2015-01-18 23:45:01 +03:00
|
|
|
mutex->current_thread = Kernel::g_handle_table.Get<Thread>(thread);
|
2014-05-21 07:03:45 +04:00
|
|
|
}
|
|
|
|
|
2014-12-07 23:44:21 +03:00
|
|
|
/**
|
|
|
|
* Resumes a thread waiting for the specified mutex
|
|
|
|
* @param mutex The mutex that some thread is waiting on
|
|
|
|
*/
|
|
|
|
void ResumeWaitingThread(Mutex* mutex) {
|
|
|
|
// Find the next waiting thread for the mutex...
|
2015-01-17 10:03:44 +03:00
|
|
|
auto next_thread = mutex->ReleaseNextThread();
|
2015-01-15 03:22:50 +03:00
|
|
|
if (next_thread != nullptr) {
|
|
|
|
MutexAcquireLock(mutex, next_thread->GetHandle());
|
|
|
|
} else {
|
2014-12-07 23:44:21 +03:00
|
|
|
// Reset mutex lock thread handle, nothing is waiting
|
|
|
|
mutex->locked = false;
|
|
|
|
mutex->lock_thread = -1;
|
|
|
|
}
|
2014-05-21 07:03:45 +04:00
|
|
|
}
|
|
|
|
|
2014-05-23 03:06:12 +04:00
|
|
|
void MutexEraseLock(Mutex* mutex) {
|
2014-05-21 07:03:45 +04:00
|
|
|
Handle handle = mutex->GetHandle();
|
|
|
|
auto locked = g_mutex_held_locks.equal_range(mutex->lock_thread);
|
|
|
|
for (MutexMap::iterator iter = locked.first; iter != locked.second; ++iter) {
|
2014-12-07 23:44:21 +03:00
|
|
|
if (iter->second == handle) {
|
2014-05-21 07:03:45 +04:00
|
|
|
g_mutex_held_locks.erase(iter);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
mutex->lock_thread = -1;
|
|
|
|
}
|
|
|
|
|
2014-12-07 23:44:21 +03:00
|
|
|
void ReleaseThreadMutexes(Handle thread) {
|
|
|
|
auto locked = g_mutex_held_locks.equal_range(thread);
|
|
|
|
|
|
|
|
// Release every mutex that the thread holds, and resume execution on the waiting threads
|
|
|
|
for (MutexMap::iterator iter = locked.first; iter != locked.second; ++iter) {
|
2014-12-29 15:55:30 +03:00
|
|
|
Mutex* mutex = g_handle_table.Get<Mutex>(iter->second).get();
|
2014-12-07 23:44:21 +03:00
|
|
|
ResumeWaitingThread(mutex);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Erase all the locks that this thread holds
|
|
|
|
g_mutex_held_locks.erase(thread);
|
|
|
|
}
|
|
|
|
|
2014-05-23 03:06:12 +04:00
|
|
|
bool LockMutex(Mutex* mutex) {
|
2014-05-21 07:03:45 +04:00
|
|
|
// Mutex alread locked?
|
|
|
|
if (mutex->locked) {
|
|
|
|
return false;
|
|
|
|
}
|
2014-05-23 03:06:12 +04:00
|
|
|
MutexAcquireLock(mutex);
|
2014-05-21 07:03:45 +04:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2014-05-23 03:06:12 +04:00
|
|
|
bool ReleaseMutex(Mutex* mutex) {
|
|
|
|
MutexEraseLock(mutex);
|
2014-12-07 23:44:21 +03:00
|
|
|
ResumeWaitingThread(mutex);
|
2014-11-26 22:37:58 +03:00
|
|
|
return true;
|
2014-05-21 07:03:45 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Releases a mutex
|
|
|
|
* @param handle Handle to mutex to release
|
|
|
|
*/
|
2014-10-23 07:20:01 +04:00
|
|
|
ResultCode ReleaseMutex(Handle handle) {
|
2014-12-29 15:55:30 +03:00
|
|
|
Mutex* mutex = Kernel::g_handle_table.Get<Mutex>(handle).get();
|
2014-10-23 07:20:01 +04:00
|
|
|
if (mutex == nullptr) return InvalidHandle(ErrorModule::Kernel);
|
2014-05-28 06:42:16 +04:00
|
|
|
|
2014-05-23 03:06:12 +04:00
|
|
|
if (!ReleaseMutex(mutex)) {
|
2014-10-23 07:20:01 +04:00
|
|
|
// TODO(yuriks): Verify error code, this one was pulled out of thin air. I'm not even sure
|
|
|
|
// what error condition this is supposed to be signaling.
|
|
|
|
return ResultCode(ErrorDescription::AlreadyDone, ErrorModule::Kernel,
|
|
|
|
ErrorSummary::NothingHappened, ErrorLevel::Temporary);
|
2014-05-21 07:03:45 +04:00
|
|
|
}
|
2014-10-23 07:20:01 +04:00
|
|
|
return RESULT_SUCCESS;
|
2014-05-21 07:03:45 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates a mutex
|
|
|
|
* @param handle Reference to handle for the newly created mutex
|
|
|
|
* @param initial_locked Specifies if the mutex should be locked initially
|
2014-06-03 04:38:34 +04:00
|
|
|
* @param name Optional name of mutex
|
2014-05-28 06:42:16 +04:00
|
|
|
* @return Pointer to new Mutex object
|
2014-05-21 07:03:45 +04:00
|
|
|
*/
|
2014-06-06 08:23:33 +04:00
|
|
|
Mutex* CreateMutex(Handle& handle, bool initial_locked, const std::string& name) {
|
2014-05-21 07:03:45 +04:00
|
|
|
Mutex* mutex = new Mutex;
|
2014-12-21 15:04:08 +03:00
|
|
|
// TODO(yuriks): Fix error reporting
|
|
|
|
handle = Kernel::g_handle_table.Create(mutex).ValueOr(INVALID_HANDLE);
|
2014-05-21 07:03:45 +04:00
|
|
|
|
|
|
|
mutex->locked = mutex->initial_locked = initial_locked;
|
2014-06-03 04:38:34 +04:00
|
|
|
mutex->name = name;
|
2015-01-18 23:45:01 +03:00
|
|
|
mutex->current_thread = nullptr;
|
2014-05-21 07:03:45 +04:00
|
|
|
|
|
|
|
// Acquire mutex with current thread if initialized as locked...
|
|
|
|
if (mutex->locked) {
|
2014-05-23 03:06:12 +04:00
|
|
|
MutexAcquireLock(mutex);
|
2014-05-21 07:03:45 +04:00
|
|
|
|
|
|
|
// Otherwise, reset lock thread handle
|
|
|
|
} else {
|
|
|
|
mutex->lock_thread = -1;
|
|
|
|
}
|
2014-05-21 07:23:58 +04:00
|
|
|
return mutex;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates a mutex
|
|
|
|
* @param initial_locked Specifies if the mutex should be locked initially
|
2014-06-03 04:38:34 +04:00
|
|
|
* @param name Optional name of mutex
|
|
|
|
* @return Handle to newly created object
|
2014-05-21 07:23:58 +04:00
|
|
|
*/
|
2014-06-06 08:23:33 +04:00
|
|
|
Handle CreateMutex(bool initial_locked, const std::string& name) {
|
2014-05-21 07:23:58 +04:00
|
|
|
Handle handle;
|
2014-06-03 04:38:34 +04:00
|
|
|
Mutex* mutex = CreateMutex(handle, initial_locked, name);
|
2014-05-21 07:23:58 +04:00
|
|
|
return handle;
|
2014-05-21 07:03:45 +04:00
|
|
|
}
|
|
|
|
|
2015-01-18 21:25:51 +03:00
|
|
|
ResultVal<bool> Mutex::Wait() {
|
2015-01-18 23:45:01 +03:00
|
|
|
return MakeResult<bool>(locked && (current_thread != GetCurrentThread()));
|
2015-01-18 06:23:49 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
ResultVal<bool> Mutex::Acquire() {
|
|
|
|
bool res = false;
|
|
|
|
|
|
|
|
if (!locked) {
|
2014-12-07 23:57:28 +03:00
|
|
|
// Lock the mutex when the first thread accesses it
|
|
|
|
locked = true;
|
2015-01-18 06:23:49 +03:00
|
|
|
res = true;
|
2014-12-07 23:57:28 +03:00
|
|
|
MutexAcquireLock(this);
|
|
|
|
}
|
|
|
|
|
2015-01-18 06:23:49 +03:00
|
|
|
return MakeResult<bool>(res);
|
2014-12-07 23:57:28 +03:00
|
|
|
}
|
2014-05-21 07:03:45 +04:00
|
|
|
} // namespace
|