tracer.h

/*******************************************************************************
 * Copyright 2016, 2018 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 _SCC_TRACER_H_
#define _SCC_TRACER_H_
 
#include "tracer_base.h"
#include <cci_configuration>
#include <string>
#include <vector>
 
#ifdef HAS_SCV
class scv_tr_db;
#else
namespace scv_tr {
class scv_tr_db;
}
#endif
namespace lwtr {
class tx_db;
}
namespace sc_core {
class sc_object;
class sc_trace_file;
} // namespace sc_core
 
namespace scc {
class tracer : public tracer_base {
public:
    enum file_type {
        NONE,
        ENABLE,
        TEXT,
        COMPRESSED,
        SQLITE,
        FTR,
        CFTR,
        LWFTR,
        LWCFTR,
        CUSTOM,
        SC_VCD = TEXT,
        PULL_VCD = COMPRESSED,
        PUSH_VCD = SQLITE,
        FST
    };
    cci::cci_param<unsigned> tx_trace_type{"tx_trace_type", CFTR,
                                           "Type of TX trace file used for recording. See also scc::tracer::file_type"};
    cci::cci_param<unsigned> sig_trace_type{"sig_trace_type", FST,
                                            "Type of signal trace file used for recording. See also scc::tracer::wave_type"};
    cci::cci_param<bool> close_db_in_eos{"close_db_in_eos", false,
                                         "Close the waveform/transaction tracing databases during end_of_simulation"};
    tracer(std::string const&& name, file_type tx_type, file_type sig_type, sc_core::sc_object* top = nullptr)
    : tracer(std::move(name), tx_type, sig_type, top, tracer_base::get_name().c_str()) {}
    tracer(std::string const& name, file_type tx_type = ENABLE, file_type sig_type = ENABLE, sc_core::sc_object* top = nullptr)
    : tracer(std::string(name), tx_type, sig_type, top) {}
    tracer(std::string const&& name, file_type type, bool enable = true, sc_core::sc_object* top = nullptr)
    : tracer(name, type, enable ? ENABLE : NONE, top) {}
    tracer(std::string const& name, file_type type, bool enable = true, sc_core::sc_object* top = nullptr)
    : tracer(name, type, enable ? ENABLE : NONE, top) {}
    tracer(std::string const&& name, file_type type, sc_core::sc_trace_file* tf, sc_core::sc_object* top = nullptr)
    : tracer(std::move(name), type, tf, top, tracer_base::get_name().c_str()) {}
    tracer(std::string const& name, file_type type, sc_core::sc_trace_file* tf, sc_core::sc_object* top = nullptr)
    : tracer(std::string(name), type, tf, top) {}
    virtual ~tracer() override;
 
protected:
    tracer(std::string const&& name, file_type tx_type, file_type sig_type, sc_core::sc_object* top, sc_core::sc_module_name const& nm);
    tracer(std::string const&& name, file_type type, sc_core::sc_trace_file* tf, sc_core::sc_object* top,
           sc_core::sc_module_name const& nm);
    void end_of_elaboration() override;
    void end_of_simulation() override;
#ifdef HAS_SCV
    scv_tr_db* txdb;
#else
    scv_tr::scv_tr_db* txdb{nullptr};
#endif
    lwtr::tx_db* lwtr_db{nullptr};
    cci::cci_broker_handle cci_broker;
 
private:
    void init_tx_db(file_type type, std::string const&& name);
    bool owned{false};
    sc_core::sc_object* top{nullptr};
};
 
} /* namespace scc */ // end of scc-sysc
#endif    /* _SCC_TRACER_H_ */