MutexArray.h

Go to the documentation of this file.

// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)
// SPDX-FileCopyrightText: 2021 Jorrit Rouwe
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <Jolt/Core/NonCopyable.h>
 
JPH_NAMESPACE_BEGIN
 
template <class MutexType>
class MutexArray : public NonCopyable
{
public:
                            MutexArray() = default;
 
    explicit                MutexArray(uint inNumMutexes) { Init(inNumMutexes); }
 
                            ~MutexArray() { delete [] mMutexStorage; }
 
    void                    Init(uint inNumMutexes)
    {
        JPH_ASSERT(mMutexStorage == nullptr);
        JPH_ASSERT(inNumMutexes > 0 && IsPowerOf2(inNumMutexes));
 
        mMutexStorage = new MutexStorage[inNumMutexes];
        mNumMutexes = inNumMutexes;
    }
 
    inline uint             GetNumMutexes() const
    {
        return mNumMutexes;
    }
 
    inline uint32           GetMutexIndex(uint32 inObjectIndex) const
    {
        Hash<uint32> hasher;
        return hasher(inObjectIndex) & (mNumMutexes - 1);
    }
 
    inline MutexType &      GetMutexByObjectIndex(uint32 inObjectIndex)
    {
        return mMutexStorage[GetMutexIndex(inObjectIndex)].mMutex;
    }
 
    inline MutexType &      GetMutexByIndex(uint32 inMutexIndex)
    {
        return mMutexStorage[inMutexIndex].mMutex;
    }
 
    void                    LockAll()
    {
        JPH_PROFILE_FUNCTION();
 
        MutexStorage *end = mMutexStorage + mNumMutexes;
        for (MutexStorage *m = mMutexStorage; m < end; ++m)
            m->mMutex.lock();
    }
 
    void                    UnlockAll()
    {
        JPH_PROFILE_FUNCTION();
 
        MutexStorage *end = mMutexStorage + mNumMutexes;
        for (MutexStorage *m = mMutexStorage; m < end; ++m)
            m->mMutex.unlock();
    }
 
private:
    struct alignas(JPH_CACHE_LINE_SIZE) MutexStorage
    {
        JPH_OVERRIDE_NEW_DELETE
 
        MutexType           mMutex;
    };
 
    MutexStorage *          mMutexStorage = nullptr;
    uint                    mNumMutexes = 0;
};
 
JPH_NAMESPACE_END