forked from github/verilator
140 lines
4.7 KiB
C++
140 lines
4.7 KiB
C++
// -*- mode: C++; c-file-style: "cc-mode" -*-
|
|
//=============================================================================
|
|
//
|
|
// Copyright 2001-2023 by Wilson Snyder. This program is free software; you can
|
|
// redistribute it and/or modify it under the terms of either the GNU
|
|
// Lesser General Public License Version 3 or the Perl Artistic License
|
|
// Version 2.0.
|
|
// SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
|
|
//
|
|
//=============================================================================
|
|
///
|
|
/// \file
|
|
/// \brief Verilated tracing in FST format for SystemC header
|
|
///
|
|
/// User wrapper code should use this header when creating FST SystemC
|
|
/// traces.
|
|
///
|
|
/// This class is not threadsafe, as the SystemC kernel is not threadsafe.
|
|
///
|
|
//=============================================================================
|
|
|
|
#ifndef VERILATOR_VERILATED_VCD_SC_H_
|
|
#define VERILATOR_VERILATED_VCD_SC_H_
|
|
|
|
#include "verilatedos.h"
|
|
|
|
#include "verilated_fst_c.h"
|
|
#include "verilated_sc.h"
|
|
|
|
#include <string>
|
|
|
|
//=============================================================================
|
|
// VerilatedFstSc
|
|
///
|
|
/// Class representing a Verilator-friendly FST trace format registered
|
|
/// with the SystemC simulation kernel, just like a SystemC-documented
|
|
/// trace format.
|
|
|
|
class VerilatedFstSc final : sc_trace_file, public VerilatedFstC {
|
|
// CONSTRUCTORS
|
|
VL_UNCOPYABLE(VerilatedFstSc);
|
|
|
|
public:
|
|
/// Construct a SC trace object, and register with the SystemC kernel
|
|
VerilatedFstSc() {
|
|
sc_get_curr_simcontext()->add_trace_file(this);
|
|
// We want to avoid a depreciated warning, but still be back compatible.
|
|
// Turning off the message just for this still results in an
|
|
// annoying "to turn off" message.
|
|
const sc_time t1sec{1, SC_SEC};
|
|
if (t1sec.to_default_time_units() != 0) {
|
|
const sc_time tunits{1.0 / t1sec.to_default_time_units(), SC_SEC};
|
|
spTrace()->set_time_unit(tunits.to_string());
|
|
}
|
|
spTrace()->set_time_resolution(sc_get_time_resolution().to_string());
|
|
}
|
|
/// Destruct, flush, and close the dump
|
|
~VerilatedFstSc() override { close(); }
|
|
|
|
// METHODS - for SC kernel
|
|
// Called by SystemC simulate()
|
|
void cycle(bool delta_cycle) override {
|
|
if (!delta_cycle) this->dump(sc_time_stamp().to_double());
|
|
}
|
|
|
|
// Override VerilatedFstC. Must be called after starting simulation.
|
|
// Note: this is not a virtual function in the base class, so no 'override'
|
|
virtual void open(const char* filename) VL_MT_SAFE {
|
|
if (VL_UNLIKELY(!sc_core::sc_get_curr_simcontext()->elaboration_done())) {
|
|
Verilated::scTraceBeforeElaborationError();
|
|
}
|
|
VerilatedFstC::open(filename);
|
|
}
|
|
|
|
private:
|
|
// METHODS - Fake outs for linker
|
|
|
|
#ifdef NC_SYSTEMC
|
|
// Cadence Incisive has these as abstract functions so we must create them
|
|
void set_time_unit(int exponent10_seconds) override {} // deprecated
|
|
#endif
|
|
void set_time_unit(double v, sc_time_unit tu) override {} // LCOV_EXCL_LINE
|
|
|
|
//--------------------------------------------------
|
|
// SystemC 2.1.v1
|
|
|
|
void write_comment(const std::string&) override {}
|
|
void trace(const unsigned int&, const std::string&, const char**) override {}
|
|
|
|
#define DECL_TRACE_METHOD_A(tp) \
|
|
void trace(const tp& object, const std::string& name) override {}
|
|
#define DECL_TRACE_METHOD_B(tp) \
|
|
void trace(const tp& object, const std::string& name, int width) override {}
|
|
|
|
// clang-format off
|
|
// Formatting matches that of sc_trace.h
|
|
// LCOV_EXCL_START
|
|
#if (SYSTEMC_VERSION >= 20171012)
|
|
DECL_TRACE_METHOD_A( sc_event )
|
|
DECL_TRACE_METHOD_A( sc_time )
|
|
#endif
|
|
|
|
DECL_TRACE_METHOD_A( bool )
|
|
DECL_TRACE_METHOD_A( sc_dt::sc_bit )
|
|
DECL_TRACE_METHOD_A( sc_dt::sc_logic )
|
|
|
|
DECL_TRACE_METHOD_B( unsigned char )
|
|
DECL_TRACE_METHOD_B( unsigned short )
|
|
DECL_TRACE_METHOD_B( unsigned int )
|
|
DECL_TRACE_METHOD_B( unsigned long )
|
|
DECL_TRACE_METHOD_B( char )
|
|
DECL_TRACE_METHOD_B( short )
|
|
DECL_TRACE_METHOD_B( int )
|
|
DECL_TRACE_METHOD_B( long )
|
|
DECL_TRACE_METHOD_B( sc_dt::int64 )
|
|
DECL_TRACE_METHOD_B( sc_dt::uint64 )
|
|
|
|
DECL_TRACE_METHOD_A( float )
|
|
DECL_TRACE_METHOD_A( double )
|
|
DECL_TRACE_METHOD_A( sc_dt::sc_int_base )
|
|
DECL_TRACE_METHOD_A( sc_dt::sc_uint_base )
|
|
DECL_TRACE_METHOD_A( sc_dt::sc_signed )
|
|
DECL_TRACE_METHOD_A( sc_dt::sc_unsigned )
|
|
|
|
DECL_TRACE_METHOD_A( sc_dt::sc_fxval )
|
|
DECL_TRACE_METHOD_A( sc_dt::sc_fxval_fast )
|
|
DECL_TRACE_METHOD_A( sc_dt::sc_fxnum )
|
|
DECL_TRACE_METHOD_A( sc_dt::sc_fxnum_fast )
|
|
|
|
DECL_TRACE_METHOD_A( sc_dt::sc_bv_base )
|
|
DECL_TRACE_METHOD_A( sc_dt::sc_lv_base )
|
|
// LCOV_EXCL_STOP
|
|
// clang-format on
|
|
|
|
#undef DECL_TRACE_METHOD_A
|
|
#undef DECL_TRACE_METHOD_B
|
|
};
|
|
|
|
#endif // Guard
|