exectos/xtoskrnl/includes/ke/guard.hh

/**
 * PROJECT:         ExectOS
 * COPYRIGHT:       See COPYING.md in the top level directory
 * FILE:            xtoskrnl/includes/ke/guard.hh
 * DESCRIPTION:     Kernel synchronization guard
 * DEVELOPERS:      Aiken Harris <harraiken91@gmail.com>
 */

#ifndef __XTOSKRNL_KE_GUARD_HH
#define __XTOSKRNL_KE_GUARD_HH

#include <xtos.hh>
#include <ke/kthread.hh>
#include <ke/proc.hh>
#include <ke/pushlock.hh>
#include <ke/spinlock.hh>


/* Kernel Library */
namespace KE
{
    class CriticalRegionGuard
    {
        private:
            BOOLEAN Owned;
            PKTHREAD SystemThread;

        public:
            CriticalRegionGuard(IN PKTHREAD Thread = NULLPTR,
                                IN BOOLEAN Acquire = TRUE)
            {
                Owned = Acquire;
                SystemThread = Thread;
                if(Owned)
                {
                    if(!SystemThread)
                    {
                        SystemThread = KE::Processor::GetCurrentThread();
                    }
                    KE::KThread::EnterCriticalRegion(SystemThread);
                }
            }

            ~CriticalRegionGuard()
            {
                if(Owned)
                {
                    KE::KThread::LeaveCriticalRegion(SystemThread);
                }
            }

            CriticalRegionGuard(const CriticalRegionGuard&) = delete;
            CriticalRegionGuard& operator=(const CriticalRegionGuard&) = delete;
    };

    class PushLockExclusiveGuard
    {
        private:
            PKPUSH_LOCK Lock;
            BOOLEAN Owned;

        public:
            PushLockExclusiveGuard(IN PKPUSH_LOCK PushLock,
                                   IN BOOLEAN Acquire = TRUE)
            {
                Lock = PushLock;
                Owned = Acquire;
                if(Owned)
                {
                    KE::PushLock::AcquireExclusivePushLock(Lock);
                }
            }

            ~PushLockExclusiveGuard()
            {
                if(Owned)
                {
                    KE::PushLock::ReleaseExclusivePushLock(Lock);
                }
            }

            PushLockExclusiveGuard(const PushLockExclusiveGuard&) = delete;
            PushLockExclusiveGuard& operator=(const PushLockExclusiveGuard&) = delete;
    };

    class PushLockSharedGuard
    {
        private:
            PKPUSH_LOCK Lock;
            BOOLEAN Owned;

        public:
            PushLockSharedGuard(IN PKPUSH_LOCK PushLock,
                                IN BOOLEAN Acquire = TRUE)
            {
                Lock = PushLock;
                Owned = Acquire;
                if(Owned)
                {
                    KE::PushLock::AcquireSharedPushLock(Lock);
                }
            }

            ~PushLockSharedGuard()
            {
                if(Owned)
                {
                    KE::PushLock::ReleaseSharedPushLock(Lock);
                }
            }

            PushLockSharedGuard(const PushLockSharedGuard&) = delete;
            PushLockSharedGuard& operator=(const PushLockSharedGuard&) = delete;
    };

    class QueuedSpinLockGuard
    {
        private:
            KLOCK_QUEUE_HANDLE LockQueueHandle;
            PKSPIN_LOCK Lock;
            BOOLEAN Owned;

        public:
            QueuedSpinLockGuard(IN OUT PKSPIN_LOCK SpinLock,
                                IN BOOLEAN Acquire = TRUE)
            {
                Lock = SpinLock;
                Owned = Acquire;
                if(Owned)
                {
                    KE::SpinLock::AcquireQueuedSpinLock(Lock, &LockQueueHandle);
                }
            }

            ~QueuedSpinLockGuard()
            {
                if(Owned)
                {
                    KE::SpinLock::ReleaseQueuedSpinLock(&LockQueueHandle);
                }
            }

            QueuedSpinLockGuard(const QueuedSpinLockGuard&) = delete;
            QueuedSpinLockGuard& operator=(const QueuedSpinLockGuard&) = delete;
    };

    class SpinLockGuard
    {
        private:
            PKSPIN_LOCK Lock;
            BOOLEAN Owned;

        public:
            SpinLockGuard(IN OUT PKSPIN_LOCK SpinLock,
                          IN BOOLEAN Acquire = TRUE)
            {
                Lock = SpinLock;
                Owned = Acquire;
                if(Owned)
                {
                    KE::SpinLock::AcquireSpinLock(Lock);
                }
            }

            ~SpinLockGuard()
            {
                if(Owned)
                {
                    KE::SpinLock::ReleaseSpinLock(Lock);
                }
            }

            SpinLockGuard(const SpinLockGuard&) = delete;
            SpinLockGuard& operator=(const SpinLockGuard&) = delete;
    };

    class SystemQueuedSpinLockGuard
    {
        private:
            KSPIN_LOCK_QUEUE_LEVEL QueuedLockLevel;
            BOOLEAN Owned;

        public:
            SystemQueuedSpinLockGuard(IN OUT KSPIN_LOCK_QUEUE_LEVEL LockLevel,
                                      IN BOOLEAN Acquire = TRUE)
            {
                QueuedLockLevel = LockLevel;
                Owned = Acquire;
                if(Owned)
                {
                    KE::SpinLock::AcquireQueuedSpinLock(QueuedLockLevel);
                }
            }

            ~SystemQueuedSpinLockGuard()
            {
                if(Owned)
                {
                    KE::SpinLock::ReleaseQueuedSpinLock(QueuedLockLevel);
                }
            }

            SystemQueuedSpinLockGuard(const SystemQueuedSpinLockGuard&) = delete;
            SystemQueuedSpinLockGuard& operator=(const SystemQueuedSpinLockGuard&) = delete;
    };
}

#endif /* __XTOSKRNL_KE_GUARD_HH */