TheRock/rocm-libraries/shared/rocroller/lib/include/rocRoller/Scheduling/WaitStateHazardCounter.hpp

// Copyright Advanced Micro Devices, Inc., or its affiliates.
// SPDX-License-Identifier: MIT

#pragma once

#include <memory>

namespace rocRoller
{
    namespace Scheduling
    {
        class WaitStateHazardCounter
        {
        public:
            WaitStateHazardCounter() {}
            WaitStateHazardCounter(int maxRequiredNops, bool written)
                : m_counter(maxRequiredNops)
                , m_maxCounter(maxRequiredNops)
                , m_written(written)
            {
            }

            /**
             * @brief Decrements the counter
             *
             * @param nops Number of NOPs associated with the decrement
             */
            void decrement(int nops)
            {
                m_counter--;
                m_counter -= nops;
            }

            /**
             * @brief Determine if the counter has reach the end of life
             *
             * @return true if this still represents a hazard
             * @return false if the counter can be safely removed
             */
            bool stillAlive() const
            {
                return m_counter > 0;
            }

            int getRequiredNops() const
            {
                return m_counter;
            }

            int getMaxNops() const
            {
                return m_maxCounter;
            }

            bool regWasWritten() const
            {
                return m_written;
            }

            bool regWasRead() const
            {
                return !m_written;
            }

        private:
            int  m_counter    = 0;
            int  m_maxCounter = 0;
            bool m_written    = false;
        };
    }
}