configurable_tracer.h

/*******************************************************************************
 * Copyright 2017, 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_CONFIGURABLE_TRACER_H_
#define _SCC_CONFIGURABLE_TRACER_H_
 
#include "tracer.h"
namespace scc {
class configurable_tracer : public tracer {
public:
    configurable_tracer(std::string const&& name, bool enable_tx = true, bool enable_vcd = true, sc_core::sc_object* top = nullptr);
    configurable_tracer(std::string const& name, bool enable_tx = true, bool enable_vcd = true, sc_core::sc_object* top = nullptr)
    : configurable_tracer(std::string(name), enable_tx, enable_vcd, top) {}

    configurable_tracer(std::string const&& name, file_type type, bool enable_vcd = true, sc_core::sc_object* top = nullptr);
    configurable_tracer(std::string const& name, file_type type, bool enable_vcd = true, sc_core::sc_object* top = nullptr)
    : configurable_tracer(std::string(name), type, enable_vcd, top) {}

    configurable_tracer(std::string const&& name, file_type tx_type, file_type sig_type, sc_core::sc_object* top = nullptr);
    configurable_tracer(std::string const& name, file_type tx_type, file_type sig_type, sc_core::sc_object* top = nullptr)
    : configurable_tracer(std::string(name), tx_type, sig_type, top) {}
    configurable_tracer(std::string const&& name, file_type type, sc_core::sc_trace_file* tf = nullptr, sc_core::sc_object* top = nullptr);
    configurable_tracer(std::string const& name, file_type type, sc_core::sc_trace_file* tf = nullptr, sc_core::sc_object* top = nullptr)
    : configurable_tracer(std::string(name), type, tf, top) {}

    ~configurable_tracer();
    void add_control() { add_control(default_trace_enable_handle.get_cci_value().get<bool>()); }
    void add_control(bool trace_default) {
        if(control_added)
            return;
        for(auto* o : sc_core::sc_get_top_level_objects())
            augment_object_hierarchical(o, trace_default);
        control_added = true;
    }
 
protected:
    void descend(const sc_core::sc_object*, bool trace_all = false) override;
    bool get_trace_enabled(const sc_core::sc_object*, bool = false);
    void augment_object_hierarchical(sc_core::sc_object*, bool);
 
    void end_of_elaboration() override;
    std::vector<cci::cci_param_untyped*> params;
    bool control_added{false};
};
 
} /* namespace scc */ // end of scc-sysc
#endif    /* _SCC_CONFIGURABLE_TRACER_H_ */