exclusive-access.h

/*
 * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All Rights Reserved.
 * Author: GreenSocs 2022
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _GREENSOCS_GSUTILS_TLM_EXTENSIONS_EXCLUSIVE_ACCESS_H
#define _GREENSOCS_GSUTILS_TLM_EXTENSIONS_EXCLUSIVE_ACCESS_H
 
#include <vector>
 
#include <tlm>
 
class ExclusiveAccessTlmExtension : public tlm::tlm_extension<ExclusiveAccessTlmExtension>
{
public:
    enum ExclusiveStoreStatus { EXCLUSIVE_STORE_NA = 0, EXCLUSIVE_STORE_SUCCESS, EXCLUSIVE_STORE_FAILURE };
 
    class InitiatorId
    {
    private:
        std::vector<int> m_id;
 
    public:
        void add_hop(int id) { m_id.push_back(id); }
 
        bool operator<(const InitiatorId& o) const
        {
            if (m_id.size() != o.m_id.size()) {
                return m_id.size() < o.m_id.size();
            }
 
            auto it0 = m_id.begin();
            auto it1 = o.m_id.begin();
            for (; it0 != m_id.end(); it0++, it1++) {
                if (*it0 != *it1) {
                    return *it0 < *it1;
                }
            }
 
            return false;
        }
 
        bool operator==(const InitiatorId& o) const
        {
            if (m_id.size() != o.m_id.size()) {
                return false;
            }
 
            auto it0 = m_id.begin();
            auto it1 = o.m_id.begin();
            for (; it0 != m_id.end(); it0++, it1++) {
                if (*it0 != *it1) {
                    return false;
                }
            }
 
            return true;
        }
 
        bool operator!=(const InitiatorId& o) const { return !(*this == o); }
    };
 
private:
    InitiatorId m_id;
    ExclusiveStoreStatus m_store_sta = EXCLUSIVE_STORE_NA;
 
public:
    ExclusiveAccessTlmExtension() = default;
    ExclusiveAccessTlmExtension(const ExclusiveAccessTlmExtension&) = default;
 
    virtual tlm_extension_base* clone() const override { return new ExclusiveAccessTlmExtension(*this); }
 
    virtual void copy_from(const tlm_extension_base& ext) override
    {
        const ExclusiveAccessTlmExtension& other = static_cast<const ExclusiveAccessTlmExtension&>(ext);
 
        m_id = other.m_id;
        m_store_sta = other.m_store_sta;
    }
 
    void set_exclusive_store_success() { m_store_sta = EXCLUSIVE_STORE_SUCCESS; }
 
    void set_exclusive_store_failure() { m_store_sta = EXCLUSIVE_STORE_FAILURE; }
 
    ExclusiveStoreStatus get_exclusive_store_status() const { return m_store_sta; }
 
    void add_hop(int id) { m_id.add_hop(id); }
 
    const InitiatorId& get_initiator_id() const { return m_id; }
};
 
#endif