tlm_extension_recording_registry.h

/*******************************************************************************
 * Copyright 2016, 2020 MINRES Technologies GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/
 
#ifndef TLM_RECORDER_REGISTRY_H_
#define TLM_RECORDER_REGISTRY_H_
 
#ifdef HAS_SCV
#include <scv.h>
#ifndef SCVNS
#define SCVNS
#endif
#else
#include <scv-tr.h>
#ifndef SCVNS
#define SCVNS ::scv_tr::
#endif
#endif
#include <tlm>

namespace tlm {
namespace scc {
namespace scv {
template <typename TYPES = tlm::tlm_base_protocol_types> class tlm_extensions_recording_if {
public:
    virtual void recordBeginTx(SCVNS scv_tr_handle& handle, typename TYPES::tlm_payload_type& trans) = 0;

    virtual void recordEndTx(SCVNS scv_tr_handle& handle, typename TYPES::tlm_payload_type& trans) = 0;
 
    virtual ~tlm_extensions_recording_if() = default;
};

template <typename TYPES = tlm::tlm_base_protocol_types> class tlm_extension_recording_registry {
public:
    static tlm_extension_recording_registry& inst() {
        static tlm_extension_recording_registry reg;
        return reg;
    }
 
    void register_ext_rec(size_t id, tlm_extensions_recording_if<TYPES>* ext) {
        if(id == 0)
            return;
        if(id >= ext_rec.size())
            ext_rec.resize(id + 1);
        if(ext_rec[id])
            delete ext_rec[id];
        ext_rec[id] = ext;
    }
 
    bool is_ext_registered(size_t id) {
        if(id == 0)
            return true;
        if(id >= ext_rec.size())
            return false;
        if(ext_rec[id])
            return true;
        return false;
    }
    const std::vector<tlm_extensions_recording_if<TYPES>*>& get() { return ext_rec; }
 
    inline void recordBeginTx(size_t id, SCVNS scv_tr_handle& handle, typename TYPES::tlm_payload_type& trans) {
        if(ext_rec.size() > id && ext_rec[id])
            ext_rec[id]->recordBeginTx(handle, trans);
    }

    inline void recordEndTx(size_t id, SCVNS scv_tr_handle& handle, typename TYPES::tlm_payload_type& trans) {
        if(ext_rec.size() > id && ext_rec[id])
            ext_rec[id]->recordEndTx(handle, trans);
    }
 
private:
    tlm_extension_recording_registry() = default;
    ~tlm_extension_recording_registry() {
        for(auto& ext : ext_rec)
            delete(ext);
    }
    std::vector<tlm_extensions_recording_if<TYPES>*> ext_rec{};
};
 
} // namespace scv
} // namespace scc
} // namespace tlm
#endif /* TLM_RECORDER_REGISTRY_H_ */