src/dawn/native/DeviceGuard.h

// Copyright 2025 The Dawn & Tint Authors
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef SRC_DAWN_NATIVE_DEVICEGUARD_H_
#define SRC_DAWN_NATIVE_DEVICEGUARD_H_

#include <mutex>
#include <optional>
#include <thread>

#include "partition_alloc/pointers/raw_ptr.h"
#include "src/dawn/common/Atomic.h"
#include "src/dawn/common/Compiler.h"
#include "src/dawn/common/Defer.h"
#include "src/dawn/common/MutexProtected.h"
#include "src/dawn/common/Ref.h"

namespace dawn::platform {
class Platform;
}  // namespace dawn::platform

namespace dawn::native {

class DeviceBase;

class DeviceMutex : public RecursiveMutex {
  public:
    explicit DeviceMutex(dawn::platform::Platform* platform);
    ~DeviceMutex() override;

  private:
    friend class DeviceBase;
    friend struct AutoLockBase<DeviceMutex*>;
    friend class DeviceMutexTest;

    void Lock() DAWN_EXCLUSIVE_LOCK_FUNCTION;
    void Unlock() DAWN_UNLOCK_FUNCTION;

    uint32_t mRecursionStackDepth = 0;
    std::optional<class Defer> mDefer = std::nullopt;
    Atomic<std::thread::id, std::memory_order_acquire, std::memory_order_release> mOwningThread{
        std::thread::id()};
    const raw_ptr<dawn::platform::Platform> mPlatform = nullptr;

    double mAcquireTimeSum = 0.0;
    double mAcquireTimeMax = 0.0;
    uint64_t mAcquireCount = 0;
};

namespace detail {

struct DeviceMutexTraits {
    using MutexType = Ref<DeviceMutex>;
    template <typename Unused>
    using LockType = DeviceMutex::AutoLockBase<DeviceMutex*>;

    static DeviceMutex* GetMutex(MutexType& m) { return m.Get(); }
    static DeviceBase* GetObj(DeviceBase* const d) { return d; }
    static const DeviceBase* GetObj(const DeviceBase* const d) { return d; }
};

// This base class is necessary for destructor ordering in the implementing DeviceGuard class
// below.
class DeviceGuardBase {
  protected:
    explicit DeviceGuardBase(DeviceMutex* mutex = nullptr);
    DeviceGuardBase(DeviceGuardBase&&) = default;

  private:
    // Optionally, this base class may hold a strong reference to the actual mutex. This is used
    // when the Device which is the owner of the mutex may be deleted while still holding the mutex.
    Ref<DeviceMutex> mMutex = nullptr;
};

}  // namespace detail

// DeviceGuard is the equivalent to a Guard when using MutexProtected specifically designed for the
// device-wide lock. Usually, Guards are scoped via lambda functions, but for the device-wide lock,
// we provide ways to get this guard and call Defer from the Device. Since the device-wide lock is a
// temporary solution, this provides a way get the guard without adding lambda scopes everywhere.
class DeviceGuard : public detail::DeviceGuardBase,
                    private ::dawn::detail::Guard<DeviceBase, detail::DeviceMutexTraits> {
  public:
    using GuardBase = ::dawn::detail::Guard<DeviceBase, detail::DeviceMutexTraits>;

    DeviceGuard(DeviceGuard&&);

  private:
    friend class DeviceBase;

    explicit DeviceGuard(DeviceBase* device, DeviceMutex* mutex = nullptr);
};

}  // namespace dawn::native

#endif  // SRC_DAWN_NATIVE_DEVICEGUARD_H_