blob: 065e03ee7850bf49c71ea2732e2542589c0b25b8 [file] [log] [blame] [edit]
// Copyright 2023 The Dawn Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef SRC_DAWN_COMMON_MUTEX_H_
#define SRC_DAWN_COMMON_MUTEX_H_
#include <atomic>
#include <mutex>
#include <thread>
#include <utility>
#include "dawn/common/Assert.h"
#include "dawn/common/NonCopyable.h"
#include "dawn/common/Ref.h"
#include "dawn/common/RefCounted.h"
namespace dawn {
class Mutex : public RefCounted, NonCopyable {
public:
template <typename MutexRef>
struct AutoLockBase : NonMovable {
AutoLockBase() : mMutex(nullptr) {}
explicit AutoLockBase(MutexRef mutex) : mMutex(std::move(mutex)) {
if (mMutex != nullptr) {
mMutex->Lock();
}
}
~AutoLockBase() {
if (mMutex != nullptr) {
mMutex->Unlock();
}
}
private:
MutexRef mMutex;
};
// This scoped lock won't keep the mutex alive.
using AutoLock = AutoLockBase<Mutex*>;
// This scoped lock will keep the mutex alive until out of scope.
using AutoLockAndHoldRef = AutoLockBase<Ref<Mutex>>;
~Mutex() override;
void Lock();
void Unlock();
// This method is only enabled when DAWN_ENABLE_ASSERTS is turned on.
// Thus it should only be wrapped inside ASSERT() macro.
// i.e. ASSERT(mutex.IsLockedByCurrentThread())
bool IsLockedByCurrentThread();
private:
#if defined(DAWN_ENABLE_ASSERTS)
std::atomic<std::thread::id> mOwner;
#endif // DAWN_ENABLE_ASSERTS
std::mutex mNativeMutex;
};
} // namespace dawn
#endif