tlm2_lwtr.h

/*
 * Copyright 2022-2023 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.
 */
 
#pragma once
 
#include "lwtr4tlm2.h"
#include <array>
#include <cci_configuration>
#include <regex>
#include <scc/peq.h>
#include <sstream>
#include <string>
#include <sysc/kernel/sc_dynamic_processes.h>
#include <tlm/scc/lwtr/lwtr4tlm2_extension_registry.h>
#include <tlm/scc/tlm_gp_shared.h>
#include <tlm/scc/tlm_mm.h>
#include <unordered_map>

namespace tlm {
namespace scc {
namespace lwtr {
 
using tx_db = ::lwtr::tx_db;
using tx_fiber = ::lwtr::tx_fiber;
template <typename BEGIN = ::lwtr::no_data, typename END = ::lwtr::no_data> using tx_generator = ::lwtr::tx_generator<BEGIN, END>;
using tx_handle = ::lwtr::tx_handle;
using mm = tlm::scc::tlm_mm<>;
 
extern bool registered;
enum tx_rel {
    PARENT_CHILD = 0,     
    PREDECESSOR_SUCCESSOR 
};

struct link_pred_ext : public tlm::tlm_extension<link_pred_ext> {
    tlm_extension_base* clone() const override {
        link_pred_ext* t = new link_pred_ext(this->txHandle, this->creator);
        return t;
    }

    void copy_from(tlm_extension_base const& from) override {
        txHandle = static_cast<link_pred_ext const&>(from).txHandle;
        creator = static_cast<link_pred_ext const&>(from).creator;
    }

    link_pred_ext(tx_handle handle, void const* creator_)
    : txHandle(handle)
    , creator(creator_) {}
    tx_handle txHandle;
    void const* creator;
};

struct nb_rec_entry {
    tlm::scc::tlm_gp_shared_ptr tr;
    tlm::tlm_phase const ph;
    uintptr_t const id;
    tx_handle parent;
};

template <typename TYPES = tlm::tlm_base_protocol_types>
class tlm2_lwtr : public virtual tlm::tlm_fw_transport_if<TYPES>, public virtual tlm::tlm_bw_transport_if<TYPES> {
public:
    cci::cci_param<bool> enableBlTracing;

    cci::cci_param<bool> enableNbTracing;

    cci::cci_param<bool> enableTimedTracing{"enableTimedTracing", true};

    cci::cci_param<bool> enableDmiTracing{"enableDmiTracing", false};

    tlm2_lwtr(bool recording_enabled = true, tx_db* tr_db = tx_db::get_default_db())
    : tlm2_lwtr(sc_core::sc_gen_unique_name("tlm_recorder"), recording_enabled, tr_db) {}
    tlm2_lwtr(const char* full_name, bool recording_enabled = true, tx_db* tr_db = tx_db::get_default_db())
    : enableBlTracing("enableBlTracing", recording_enabled)
    , enableNbTracing("enableNbTracing", recording_enabled)
    , full_name(full_name)
    , nb_timed_peq()
    , m_db(tr_db) {
        sc_core::sc_spawn_options opts;
        opts.spawn_method();
        opts.dont_initialize();
        opts.set_sensitivity(&nb_timed_peq.event());
        sc_core::sc_spawn([this]() { nbtx_cb(); }, nullptr, &opts);
        initialize_streams();
    }
 
    virtual ~tlm2_lwtr() override {
        nbtx_req_handle_map.clear();
        nbtx_last_req_handle_map.clear();
        delete b_streamHandle;
        for(auto* p : b_trHandle)
            delete p; // NOLINT
        delete b_streamHandleTimed;
        for(auto* p : b_trTimedHandle)
            delete p; // NOLINT
        delete nb_streamHandle;
        for(auto* p : nb_trHandle)
            delete p; // NOLINT
        delete nb_streamHandleTimed;
        for(auto* p : nb_trTimedHandle)
            delete p; // NOLINT
        delete dmi_streamHandle;
        delete dmi_trGetHandle;
        delete dmi_trInvalidateHandle;
    }
 
    // TLM-2.0 interface methods for initiator and target sockets, surrounded with
    // Tx Recording
    tlm::tlm_sync_enum nb_transport_fw(typename TYPES::tlm_payload_type& trans, typename TYPES::tlm_phase_type& phase,
                                       sc_core::sc_time& delay) override;

    tlm::tlm_sync_enum nb_transport_bw(typename TYPES::tlm_payload_type& trans, typename TYPES::tlm_phase_type& phase,
                                       sc_core::sc_time& delay) override;

    void b_transport(typename TYPES::tlm_payload_type& trans, sc_core::sc_time& delay) override;
    bool get_direct_mem_ptr(typename TYPES::tlm_payload_type& trans, tlm::tlm_dmi& dmi_data) override;
    void invalidate_direct_mem_ptr(sc_dt::uint64 start_addr, sc_dt::uint64 end_addr) override;
    unsigned int transport_dbg(typename TYPES::tlm_payload_type& trans) override;
    inline bool isRecordingBlockingTxEnabled() const { return m_db && enableBlTracing.get_value(); }
    inline bool isRecordingNonBlockingTxEnabled() const { return m_db && enableNbTracing.get_value(); }
 
protected:
    sc_core::sc_port<tlm::tlm_fw_transport_if<TYPES>> fw_port{"fw_port"};

    sc_core::sc_port<tlm::tlm_bw_transport_if<TYPES>> bw_port{"bw_port"};
 
private:
    std::string const full_name;
    ::scc::peq<nb_rec_entry> nb_timed_peq;
    void nbtx_cb();
    tx_db* m_db{nullptr};
    ::lwtr::tx_relation_handle pred_succ_hndl{0}, par_chld_hndl{0};
    tx_fiber* b_streamHandle{nullptr};
    std::array<tx_generator<sc_core::sc_time, sc_core::sc_time>*, 3> b_trHandle{{nullptr, nullptr, nullptr}};
    tx_fiber* b_streamHandleTimed{nullptr};
    std::array<tx_generator<>*, 3> b_trTimedHandle{{nullptr, nullptr, nullptr}};
 
    enum DIR { FW, BW, REQ = FW, RESP = BW };
    tx_fiber* nb_streamHandle{nullptr};
    tx_fiber* nb_streamHandleTimed{nullptr};
    std::array<tx_generator<std::string, std::string>*, 2> nb_trHandle{{nullptr, nullptr}};
    std::array<tx_generator<>*, 2> nb_trTimedHandle{{nullptr, nullptr}};
    std::unordered_map<uint64_t, tx_handle> nbtx_req_handle_map;
    std::unordered_map<uint64_t, tx_handle> nbtx_last_req_handle_map;

    tx_fiber* dmi_streamHandle{nullptr};
    tx_generator<>* dmi_trGetHandle{nullptr};
    tx_generator<sc_dt::uint64, sc_dt::uint64>* dmi_trInvalidateHandle{nullptr};
 
protected:
    void initialize_streams() {
        if(m_db) {
            pred_succ_hndl = m_db->create_relation("PREDECESSOR_SUCCESSOR");
            par_chld_hndl = m_db->create_relation("PARENT_CHILD");
        }
        if(isRecordingBlockingTxEnabled() && !b_streamHandle) {
            b_streamHandle = new tx_fiber((full_name + "_bl").c_str(), "[TLM][base-protocol][b]", m_db);
            b_trHandle[tlm::TLM_READ_COMMAND] =
                new tx_generator<sc_core::sc_time, sc_core::sc_time>("read", *b_streamHandle, "start_delay", "end_delay");
            b_trHandle[tlm::TLM_WRITE_COMMAND] =
                new tx_generator<sc_core::sc_time, sc_core::sc_time>("write", *b_streamHandle, "start_delay", "end_delay");
            b_trHandle[tlm::TLM_IGNORE_COMMAND] =
                new tx_generator<sc_core::sc_time, sc_core::sc_time>("ignore", *b_streamHandle, "start_delay", "end_delay");
            if(enableTimedTracing.get_value()) {
                b_streamHandleTimed = new tx_fiber((full_name + "_bl_timed").c_str(), "[TLM][base-protocol][b][timed]", m_db);
                b_trTimedHandle[tlm::TLM_READ_COMMAND] = new tx_generator<>("read", *b_streamHandleTimed);
                b_trTimedHandle[tlm::TLM_WRITE_COMMAND] = new tx_generator<>("write", *b_streamHandleTimed);
                b_trTimedHandle[tlm::TLM_IGNORE_COMMAND] = new tx_generator<>("ignore", *b_streamHandleTimed);
            }
        }
        if(isRecordingNonBlockingTxEnabled() && !nb_streamHandle) {
            nb_streamHandle = new tx_fiber((full_name + "_nb").c_str(), "[TLM][base-protocol][nb]", m_db);
            nb_trHandle[FW] = new tx_generator<std::string, std::string>("fw", *nb_streamHandle, "tlm_phase", "tlm_phase[return_path]");
            nb_trHandle[BW] = new tx_generator<std::string, std::string>("bw", *nb_streamHandle, "tlm_phase", "tlm_phase[return_path]");
            if(enableTimedTracing.get_value()) {
                nb_streamHandleTimed = new tx_fiber((full_name + "_nb_timed").c_str(), "[TLM][base-protocol][nb][timed]", m_db);
                nb_trTimedHandle[FW] = new tx_generator<>("request", *nb_streamHandleTimed);
                nb_trTimedHandle[BW] = new tx_generator<>("response", *nb_streamHandleTimed);
            }
        }
        if(m_db && enableDmiTracing.get_value() && !dmi_streamHandle) {
            dmi_streamHandle = new tx_fiber((full_name + "_dmi").c_str(), "[TLM][base-protocol][dmi]", m_db);
            dmi_trGetHandle = new tx_generator<>("get", *dmi_streamHandle);
            dmi_trInvalidateHandle =
                new tx_generator<sc_dt::uint64, sc_dt::uint64>("invalidate", *dmi_streamHandle, "start_addr", "end_addr");
        }
    }
 
private:
    inline std::string phase2string(const tlm::tlm_phase& p) {
        std::stringstream ss;
        ss << p;
        return ss.str();
    }
};
 
template <unsigned BUSWIDTH = 32, typename TYPES = tlm::tlm_base_protocol_types, int N = 1,
          sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
class tlm2_lwtr_recorder : public sc_core::sc_module, public tlm2_lwtr<TYPES> {
public:
    tlm::tlm_target_socket<BUSWIDTH, TYPES, N, POL> ts{"ts"};
    tlm::tlm_initiator_socket<BUSWIDTH, TYPES, N, POL> is{"is"};
 
    tlm2_lwtr_recorder(sc_core::sc_module_name nm, bool recording_enabled = true, tx_db* tr_db = tx_db::get_default_db())
    : sc_core::sc_module(nm)
    , tlm2_lwtr<TYPES>(name(), recording_enabled, tr_db) {
        is(*this);
        ts(*this);
        this->bw_port(ts.get_base_port());
        this->fw_port(is.get_base_port());
    }
};

// implementations of functions
 
template <typename TYPES> void tlm2_lwtr<TYPES>::b_transport(typename TYPES::tlm_payload_type& trans, sc_core::sc_time& delay) {
    if(!isRecordingBlockingTxEnabled()) {
        fw_port->b_transport(trans, delay);
        return;
    }
    // Get a handle for the new transaction
    tx_handle h = b_trHandle[trans.get_command()]->begin_tx(delay);
    tx_handle htim;
    /*************************************************************************
     * do the timed notification
     *************************************************************************/
    if(b_streamHandleTimed)
        htim = b_trTimedHandle[trans.get_command()]->begin_tx_delayed(sc_core::sc_time_stamp() + delay, par_chld_hndl, h);
 
    if(registered)
        for(auto& extensionRecording : lwtr4tlm2_extension_registry<TYPES>::inst().get())
            if(extensionRecording) {
                extensionRecording->recordBeginTx(h, trans);
                if(htim.is_valid())
                    extensionRecording->recordBeginTx(htim, trans);
            }
    link_pred_ext* preExt = nullptr;
 
    trans.get_extension(preExt);
    if(preExt == nullptr) { // we are the first recording this transaction
        preExt = new link_pred_ext(h, this);
        if(trans.has_mm())
            trans.set_auto_extension(preExt);
        else
            trans.set_extension(preExt);
    } else {
        h.add_relation(pred_succ_hndl, preExt->txHandle);
    }
    tx_handle preTx{preExt->txHandle};
    preExt->txHandle = h;
    fw_port->b_transport(trans, delay);
    trans.get_extension(preExt);
    if(preExt->creator == this) {
        // clean-up the extension if this is the original creator
        trans.set_extension(static_cast<link_pred_ext*>(nullptr));
        if(!trans.has_mm()) {
            delete preExt;
        }
    } else {
        preExt->txHandle = preTx;
    }
    h.record_attribute("trans", trans);
    if(registered)
        for(auto& extensionRecording : lwtr4tlm2_extension_registry<TYPES>::inst().get())
            if(extensionRecording) {
                extensionRecording->recordEndTx(h, trans);
                if(htim.is_active())
                    extensionRecording->recordEndTx(htim, trans);
            }
    // End the transaction
    h.end_tx(delay);
    // and now the stuff for the timed tx
    if(htim.is_valid()) {
        htim.record_attribute("trans", trans);
        htim.end_tx_delayed(sc_core::sc_time_stamp() + delay);
    }
}
 
template <typename TYPES>
tlm::tlm_sync_enum tlm2_lwtr<TYPES>::nb_transport_fw(typename TYPES::tlm_payload_type& trans, typename TYPES::tlm_phase_type& phase,
                                                     sc_core::sc_time& delay) {
    if(!isRecordingNonBlockingTxEnabled())
        return fw_port->nb_transport_fw(trans, phase, delay);
    /*************************************************************************
     * prepare recording
     *************************************************************************/
    // Get a handle for the new transaction
    tx_handle h = nb_trHandle[FW]->begin_tx(phase2string(phase));
    link_pred_ext* preExt = nullptr;
    trans.get_extension(preExt);
    if(preExt == nullptr) { // we are the first recording this transaction
        preExt = new link_pred_ext(h, this);
        if(trans.has_mm())
            trans.set_auto_extension(preExt);
        else
            trans.set_extension(preExt);
    } else {
        // link handle if we have a predecessor
        h.add_relation(pred_succ_hndl, preExt->txHandle);
    }
    // update the extension
    preExt->txHandle = h;
    h.record_attribute("delay", delay);
    if(registered)
        for(auto& extensionRecording : lwtr4tlm2_extension_registry<TYPES>::inst().get())
            if(extensionRecording)
                extensionRecording->recordBeginTx(h, trans);
    /*************************************************************************
     * do the timed notification
     *************************************************************************/
    if(nb_streamHandleTimed) {
        nb_rec_entry rec{mm::get().allocate(), phase, reinterpret_cast<uint64_t>(&trans), h};
        rec.tr->deep_copy_from(trans);
        nb_timed_peq.notify(rec, delay);
    }
    /*************************************************************************
     * do the access
     *************************************************************************/
    tlm::tlm_sync_enum status = fw_port->nb_transport_fw(trans, phase, delay);
    /*************************************************************************
     * handle recording
     *************************************************************************/
    h.record_attribute("tlm_sync", status);
    h.record_attribute("delay[return_path]", delay);
    h.record_attribute("trans", trans);
    if(registered)
        for(auto& extensionRecording : lwtr4tlm2_extension_registry<TYPES>::inst().get())
            if(extensionRecording)
                extensionRecording->recordEndTx(h, trans);
    // get the extension and free the memory if it was mine
    if(status == tlm::TLM_COMPLETED || (status == tlm::TLM_ACCEPTED && phase == tlm::END_RESP)) {
        trans.get_extension(preExt);
        if(preExt && preExt->creator == this) {
            trans.set_extension(static_cast<link_pred_ext*>(nullptr));
            if(!trans.has_mm()) {
                delete preExt;
            }
        }
        /*************************************************************************
         * do the timed notification if req. finished here
         *************************************************************************/
        if(nb_streamHandleTimed) {
            nb_rec_entry rec{mm::get().allocate(), phase, reinterpret_cast<uint64_t>(&trans), h};
            rec.tr->deep_copy_from(trans);
            nb_timed_peq.notify(rec, delay);
        }
    } else if(nb_streamHandleTimed && status == tlm::TLM_UPDATED) {
        nb_rec_entry rec{mm::get().allocate(), phase, reinterpret_cast<uint64_t>(&trans), h};
        rec.tr->deep_copy_from(trans);
        nb_timed_peq.notify(rec, delay);
    }
    // End the transaction
    nb_trHandle[FW]->end_tx(h, phase2string(phase));
    return status;
}
 
template <typename TYPES>
tlm::tlm_sync_enum tlm2_lwtr<TYPES>::nb_transport_bw(typename TYPES::tlm_payload_type& trans, typename TYPES::tlm_phase_type& phase,
                                                     sc_core::sc_time& delay) {
    if(!isRecordingNonBlockingTxEnabled())
        return bw_port->nb_transport_bw(trans, phase, delay);
    /*************************************************************************
     * prepare recording
     *************************************************************************/
    link_pred_ext* preExt = nullptr;
    trans.get_extension(preExt);
    // Get a handle for the new transaction
    tx_handle h = nb_trHandle[BW]->begin_tx(phase2string(phase));
    // link handle if we have a predecessor and that's not ourself
    if(preExt) {
        h.add_relation(pred_succ_hndl, preExt->txHandle);
        // and set the extension handle to this transaction
        preExt->txHandle = h;
    }
    // and set the extension handle to this transaction
    h.record_attribute("delay", delay);
    for(auto& extensionRecording : lwtr4tlm2_extension_registry<TYPES>::inst().get())
        if(extensionRecording)
            extensionRecording->recordBeginTx(h, trans);
    /*************************************************************************
     * do the timed notification
     *************************************************************************/
    if(nb_streamHandleTimed) {
        nb_rec_entry rec{mm::get().allocate(), phase, reinterpret_cast<uint64_t>(&trans), h};
        rec.tr->deep_copy_from(trans);
        nb_timed_peq.notify(rec, delay);
    }
    /*************************************************************************
     * do the access
     *************************************************************************/
    tlm::tlm_sync_enum status = bw_port->nb_transport_bw(trans, phase, delay);
    /*************************************************************************
     * handle recording
     *************************************************************************/
    h.record_attribute("tlm_sync", status);
    h.record_attribute("delay[return_path]", delay);
    h.record_attribute("trans", trans);
    if(registered)
        for(auto& extensionRecording : lwtr4tlm2_extension_registry<TYPES>::inst().get())
            if(extensionRecording)
                extensionRecording->recordEndTx(h, trans);
    // End the transaction
    nb_trHandle[BW]->end_tx(h, phase2string(phase));
    // get the extension and free the memory if it was mine
    if(status == tlm::TLM_COMPLETED || (status == tlm::TLM_UPDATED && phase == tlm::END_RESP)) {
        // the transaction is finished
        if(preExt && preExt->creator == this) {
            // clean-up the extension if this is the original creator
            trans.set_extension(static_cast<link_pred_ext*>(nullptr));
            if(!trans.has_mm()) {
                delete preExt;
            }
        }
        /*************************************************************************
         * do the timed notification if req. finished here
         *************************************************************************/
        if(nb_streamHandleTimed) {
            nb_rec_entry rec{mm::get().allocate(), phase, reinterpret_cast<uint64_t>(&trans), h};
            rec.tr->deep_copy_from(trans);
            nb_timed_peq.notify(rec, delay);
        }
    }
    return status;
}
 
template <typename TYPES> void tlm2_lwtr<TYPES>::nbtx_cb() {
    auto opt = nb_timed_peq.get_next();
    if(opt) {
        auto& e = opt.get();
        tx_handle h;
        switch(e.ph) { // Now process outstanding recordings
        case tlm::BEGIN_REQ:
            h = nb_trTimedHandle[REQ]->begin_tx(par_chld_hndl, e.parent);
            nbtx_req_handle_map[e.id] = h;
            break;
        case tlm::END_REQ: {
            auto it = nbtx_req_handle_map.find(e.id);
            sc_assert(it != nbtx_req_handle_map.end());
            h = it->second;
            nbtx_req_handle_map.erase(it);
            h.record_attribute("trans", *e.tr);
            h.end_tx();
            nbtx_last_req_handle_map[e.id] = h;
        } break;
        case tlm::BEGIN_RESP: {
            auto it = nbtx_req_handle_map.find(e.id);
            if(it != nbtx_req_handle_map.end()) {
                h = it->second;
                nbtx_req_handle_map.erase(it);
                h.record_attribute("trans", *e.tr);
                h.end_tx();
                nbtx_last_req_handle_map[e.id] = h;
            }
            h = nb_trTimedHandle[RESP]->begin_tx(par_chld_hndl, e.parent);
            nbtx_req_handle_map[e.id] = h;
            it = nbtx_last_req_handle_map.find(e.id);
            if(it != nbtx_last_req_handle_map.end()) {
                tx_handle pred = it->second;
                nbtx_last_req_handle_map.erase(it);
                h.add_relation(pred_succ_hndl, pred);
            }
        } break;
        case tlm::END_RESP: {
            auto it = nbtx_req_handle_map.find(e.id);
            if(it != nbtx_req_handle_map.end()) {
                h = it->second;
                nbtx_req_handle_map.erase(it);
                h.record_attribute("trans", *e.tr);
                h.end_tx();
            }
        } break;
        default:
            // sc_assert(!"phase not supported!");
            break;
        }
    }
    return;
}
 
template <typename TYPES> bool tlm2_lwtr<TYPES>::get_direct_mem_ptr(typename TYPES::tlm_payload_type& trans, tlm::tlm_dmi& dmi_data) {
    if(!(m_db && enableDmiTracing.get_value()))
        return fw_port->get_direct_mem_ptr(trans, dmi_data);
    tx_handle h = dmi_trGetHandle->begin_tx();
    bool status = fw_port->get_direct_mem_ptr(trans, dmi_data);
    h.record_attribute("trans", trans);
    h.record_attribute("dmi_data", dmi_data);
    h.end_tx();
    return status;
}

template <typename TYPES> void tlm2_lwtr<TYPES>::invalidate_direct_mem_ptr(sc_dt::uint64 start_addr, sc_dt::uint64 end_addr) {
    if(!(m_db && enableDmiTracing.get_value())) {
        bw_port->invalidate_direct_mem_ptr(start_addr, end_addr);
        return;
    }
    tx_handle h = dmi_trInvalidateHandle->begin_tx(start_addr);
    bw_port->invalidate_direct_mem_ptr(start_addr, end_addr);
    dmi_trInvalidateHandle->end_tx(h, end_addr);
    return;
}

template <typename TYPES> unsigned int tlm2_lwtr<TYPES>::transport_dbg(typename TYPES::tlm_payload_type& trans) {
    return fw_port->transport_dbg(trans);
}
} // namespace lwtr
} // namespace scc
} // namespace tlm