gem5  v22.1.0.0
sc_trace_file.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2018 Google, Inc.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met: redistributions of source code must retain the above copyright
7  * notice, this list of conditions and the following disclaimer;
8  * redistributions in binary form must reproduce the above copyright
9  * notice, this list of conditions and the following disclaimer in the
10  * documentation and/or other materials provided with the distribution;
11  * neither the name of the copyright holders nor the names of its
12  * contributors may be used to endorse or promote products derived from
13  * this software without specific prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef __SYSTEMC_EXT_UTIL_SC_TRACE_FILE_HH__
29 #define __SYSTEMC_EXT_UTIL_SC_TRACE_FILE_HH__
30 
31 #include <exception>
32 
33 #include "../core/sc_time.hh"
34 
35 namespace sc_dt
36 {
37 
38 class sc_logic;
39 class sc_int_base;
40 class sc_uint_base;
41 class sc_signed;
42 class sc_unsigned;
43 class sc_bv_base;
44 class sc_lv_base;
45 class sc_fxval;
46 class sc_fxval_fast;
47 class sc_fxnum;
48 class sc_fxnum_fast;
49 
50 } // namespace sc_dt
51 
52 namespace sc_core
53 {
54 
55 template <class T>
56 class sc_signal_in_if;
57 
58 class sc_event;
59 class sc_time;
60 
61 class sc_trace_file
62 {
63  protected:
64  sc_trace_file();
65 
66  public:
67  virtual ~sc_trace_file();
68 
69  virtual void set_time_unit(double, sc_time_unit) = 0;
70 };
71 
72 sc_trace_file *sc_create_vcd_trace_file(const char *name);
73 void sc_close_vcd_trace_file(sc_trace_file *tf);
74 void sc_write_comment(sc_trace_file *tf, const std::string &comment);
75 
76 void sc_trace(sc_trace_file *, const bool &, const std::string &);
77 void sc_trace(sc_trace_file *, const bool *, const std::string &);
78 void sc_trace(sc_trace_file *, const float &, const std::string &);
79 void sc_trace(sc_trace_file *, const float *, const std::string &);
80 void sc_trace(sc_trace_file *, const double &, const std::string &);
81 void sc_trace(sc_trace_file *, const double *, const std::string &);
82 void sc_trace(sc_trace_file *, const sc_dt::sc_logic &, const std::string &);
83 void sc_trace(sc_trace_file *, const sc_dt::sc_logic *, const std::string &);
84 void sc_trace(sc_trace_file *, const sc_dt::sc_int_base &,
85  const std::string &);
86 void sc_trace(sc_trace_file *, const sc_dt::sc_int_base *,
87  const std::string &);
88 void sc_trace(sc_trace_file *, const sc_dt::sc_uint_base &,
89  const std::string &);
90 void sc_trace(sc_trace_file *, const sc_dt::sc_uint_base *,
91  const std::string &);
92 void sc_trace(sc_trace_file *, const sc_dt::sc_signed &, const std::string &);
93 void sc_trace(sc_trace_file *, const sc_dt::sc_signed *, const std::string &);
94 void sc_trace(sc_trace_file *, const sc_dt::sc_unsigned &,
95  const std::string &);
96 void sc_trace(sc_trace_file *, const sc_dt::sc_unsigned *,
97  const std::string &);
98 void sc_trace(sc_trace_file *, const sc_dt::sc_bv_base &, const std::string &);
99 void sc_trace(sc_trace_file *, const sc_dt::sc_bv_base *, const std::string &);
100 void sc_trace(sc_trace_file *, const sc_dt::sc_lv_base &, const std::string &);
101 void sc_trace(sc_trace_file *, const sc_dt::sc_lv_base *, const std::string &);
102 void sc_trace(sc_trace_file *, const sc_dt::sc_fxval &, const std::string &);
103 void sc_trace(sc_trace_file *, const sc_dt::sc_fxval *, const std::string &);
104 void sc_trace(sc_trace_file *, const sc_dt::sc_fxval_fast &,
105  const std::string &);
106 void sc_trace(sc_trace_file *, const sc_dt::sc_fxval_fast *,
107  const std::string &);
108 void sc_trace(sc_trace_file *, const sc_dt::sc_fxnum &, const std::string &);
109 void sc_trace(sc_trace_file *, const sc_dt::sc_fxnum *, const std::string &);
110 void sc_trace(sc_trace_file *, const sc_dt::sc_fxnum_fast &,
111  const std::string &);
112 void sc_trace(sc_trace_file *, const sc_dt::sc_fxnum_fast *,
113  const std::string &);
114 
115 
116 // Nonstandard
117 // sc_trace overloads for sc_event and sc_time.
118 void sc_trace(sc_trace_file *, const sc_event &, const std::string &);
119 void sc_trace(sc_trace_file *, const sc_event *, const std::string &);
120 void sc_trace(sc_trace_file *, const sc_time &, const std::string &);
121 void sc_trace(sc_trace_file *, const sc_time *, const std::string &);
122 
123 
124 // Nonstandard - unsigned versions necessary to avoid ambiguous overload
125 // resolution.
126 void sc_trace(sc_trace_file *, const unsigned char &,
127  const std::string &, int width=(8 * sizeof(unsigned char)));
128 void sc_trace(sc_trace_file *, const unsigned char *,
129  const std::string &, int width=(8 * sizeof(unsigned char)));
130 void sc_trace(sc_trace_file *, const unsigned short &,
131  const std::string &, int width=(8 * sizeof(unsigned short)));
132 void sc_trace(sc_trace_file *, const unsigned short *,
133  const std::string &, int width=(8 * sizeof(unsigned short)));
134 void sc_trace(sc_trace_file *, const unsigned int &,
135  const std::string &, int width=(8 * sizeof(unsigned int)));
136 void sc_trace(sc_trace_file *, const unsigned int *,
137  const std::string &, int width=(8 * sizeof(unsigned int)));
138 void sc_trace(sc_trace_file *, const unsigned long &,
139  const std::string &, int width=(8 * sizeof(unsigned long)));
140 void sc_trace(sc_trace_file *, const unsigned long *,
141  const std::string &, int width=(8 * sizeof(unsigned long)));
142 
143 void sc_trace(sc_trace_file *, const char &,
144  const std::string &, int width=(8 * sizeof(char)));
145 void sc_trace(sc_trace_file *, const char *,
146  const std::string &, int width=(8 * sizeof(char)));
147 void sc_trace(sc_trace_file *, const short &,
148  const std::string &, int width=(8 * sizeof(short)));
149 void sc_trace(sc_trace_file *, const short *,
150  const std::string &, int width=(8 * sizeof(short)));
151 void sc_trace(sc_trace_file *, const int &,
152  const std::string &, int width=(8 * sizeof(int)));
153 void sc_trace(sc_trace_file *, const int *,
154  const std::string &, int width=(8 * sizeof(int)));
155 void sc_trace(sc_trace_file *, const long &,
156  const std::string &, int width=(8 * sizeof(long)));
157 void sc_trace(sc_trace_file *, const long *,
158  const std::string &, int width=(8 * sizeof(long)));
159 void sc_trace(sc_trace_file *, const sc_dt::int64 &,
160  const std::string &, int width=(8 * sizeof(sc_dt::int64)));
161 void sc_trace(sc_trace_file *, const sc_dt::int64 *,
162  const std::string &, int width=(8 * sizeof(sc_dt::int64)));
163 void sc_trace(sc_trace_file *, const sc_dt::uint64 &,
164  const std::string &, int width=(8 * sizeof(sc_dt::uint64)));
165 void sc_trace(sc_trace_file *, const sc_dt::uint64 *,
166  const std::string &, int width=(8 * sizeof(sc_dt::uint64)));
167 
168 // Nonstandard function for enums
169 void sc_trace(sc_trace_file *, const unsigned int &,
170  const std::string &, const char **enum_literals);
171 
172 // Deprecated
173 void sc_trace_delta_cycles(sc_trace_file *, bool on=true);
174 
175 template <class T>
176 void
177 sc_trace(sc_trace_file *tf, const sc_signal_in_if<T> &iface,
178  const std::string &name)
179 {
180  sc_trace(tf, iface.read(), name);
181 }
182 
183 void sc_trace(sc_trace_file *, const sc_signal_in_if<char> &,
184  const std::string &, int width);
185 
186 void sc_trace(sc_trace_file *, const sc_signal_in_if<short> &,
187  const std::string &, int width);
188 
189 void sc_trace(sc_trace_file *, const sc_signal_in_if<int> &,
190  const std::string &, int width);
191 
192 void sc_trace(sc_trace_file *, const sc_signal_in_if<long> &,
193  const std::string &, int width);
194 
195 } // namespace sc_core
196 
197 #endif //__SYSTEMC_EXT_UTIL_SC_TRACE_FILE_HH__
sc_core::sc_event
Definition: sc_event.hh:170
sc_core::sc_signal_in_if
Definition: sc_signal_in_if.hh:54
sc_core::sc_signal_in_if::read
virtual const T & read() const =0
sc_core::sc_time
Definition: sc_time.hh:50
sc_core::sc_trace_file
Definition: sc_trace_file.hh:62
sc_core::sc_trace_file::~sc_trace_file
virtual ~sc_trace_file()
Definition: sc_trace_file.cc:49
sc_core::sc_trace_file::sc_trace_file
sc_trace_file()
Definition: sc_trace_file.cc:48
sc_core::sc_trace_file::set_time_unit
virtual void set_time_unit(double, sc_time_unit)=0
sc_dt::sc_bv_base
Definition: sc_bv_base.hh:75
sc_dt::sc_fxnum_fast
Definition: sc_fxnum.hh:845
sc_dt::sc_fxnum
Definition: sc_fxnum.hh:484
sc_dt::sc_fxval_fast
Definition: sc_fxval.hh:377
sc_dt::sc_fxval
Definition: sc_fxval.hh:87
sc_dt::sc_int_base
Definition: sc_int_base.hh:495
sc_dt::sc_logic
Definition: sc_logic.hh:99
sc_dt::sc_lv_base
Definition: sc_lv_base.hh:85
sc_dt::sc_signed
Definition: sc_signed.hh:985
sc_dt::sc_uint_base
Definition: sc_uint_base.hh:466
sc_dt::sc_unsigned
Definition: sc_unsigned.hh:891
sc_fxval
#define sc_fxval
Definition: fx_precision_double.h:65
gem5::ArmISA::width
Bitfield< 4 > width
Definition: misc_types.hh:72
gem5::MipsISA::on
Bitfield< 0 > on
Definition: dt_constants.hh:90
gem5::X86ISA::tf
Bitfield< 8 > tf
Definition: misc.hh:574
sc_core
Definition: messages.cc:32
sc_core::sc_create_vcd_trace_file
sc_trace_file * sc_create_vcd_trace_file(const char *name)
Definition: sc_trace_file.cc:52
sc_core::sc_trace_delta_cycles
void sc_trace_delta_cycles(sc_trace_file *, bool on=true)
Definition: sc_trace_file.cc:452
sc_core::sc_close_vcd_trace_file
void sc_close_vcd_trace_file(sc_trace_file *tf)
Definition: sc_trace_file.cc:58
sc_core::sc_time_unit
sc_time_unit
Definition: sc_time.hh:40
sc_core::sc_trace
void sc_trace(sc_trace_file *tf, const sc_in< T > &i, const std::string &name)
Definition: sc_in.hh:156
sc_core::sc_write_comment
void sc_write_comment(sc_trace_file *tf, const std::string &comment)
Definition: sc_trace_file.cc:64
sc_dt
Definition: sc_bit.cc:68
sc_dt::uint64
uint64_t uint64
Definition: sc_nbdefs.hh:172
sc_dt::int64
int64_t int64
Definition: sc_nbdefs.hh:171
name
const std::string & name()
Definition: trace.cc:49
Generated on Wed Dec 21 2022 10:22:42 for gem5 by doxygen 1.9.1