gem5  v19.0.0.0
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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  * Authors: Gabe Black
28  */
29 
30 #ifndef __SYSTEMC_EXT_UTIL_SC_TRACE_FILE_HH__
31 #define __SYSTEMC_EXT_UTIL_SC_TRACE_FILE_HH__
32 
33 #include <exception>
34 
35 #include "../core/sc_time.hh"
36 
37 namespace sc_dt
38 {
39 
40 class sc_logic;
41 class sc_int_base;
42 class sc_uint_base;
43 class sc_signed;
44 class sc_unsigned;
45 class sc_bv_base;
46 class sc_lv_base;
47 class sc_fxval;
48 class sc_fxval_fast;
49 class sc_fxnum;
50 class sc_fxnum_fast;
51 
52 } // namespace sc_dt
53 
54 namespace sc_core
55 {
56 
57 template <class T>
58 class sc_signal_in_if;
59 
60 class sc_event;
61 class sc_time;
62 
63 class sc_trace_file
64 {
65  protected:
66  sc_trace_file();
67 
68  public:
69  virtual ~sc_trace_file();
70 
71  virtual void set_time_unit(double, sc_time_unit) = 0;
72 };
73 
74 sc_trace_file *sc_create_vcd_trace_file(const char *name);
75 void sc_close_vcd_trace_file(sc_trace_file *tf);
76 void sc_write_comment(sc_trace_file *tf, const std::string &comment);
77 
78 void sc_trace(sc_trace_file *, const bool &, const std::string &);
79 void sc_trace(sc_trace_file *, const bool *, const std::string &);
80 void sc_trace(sc_trace_file *, const float &, const std::string &);
81 void sc_trace(sc_trace_file *, const float *, const std::string &);
82 void sc_trace(sc_trace_file *, const double &, const std::string &);
83 void sc_trace(sc_trace_file *, const double *, const std::string &);
84 void sc_trace(sc_trace_file *, const sc_dt::sc_logic &, const std::string &);
85 void sc_trace(sc_trace_file *, const sc_dt::sc_logic *, 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_int_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_uint_base *,
93  const std::string &);
94 void sc_trace(sc_trace_file *, const sc_dt::sc_signed &, const std::string &);
95 void sc_trace(sc_trace_file *, const sc_dt::sc_signed *, 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_unsigned *,
99  const std::string &);
100 void sc_trace(sc_trace_file *, const sc_dt::sc_bv_base &, const std::string &);
101 void sc_trace(sc_trace_file *, const sc_dt::sc_bv_base *, const std::string &);
102 void sc_trace(sc_trace_file *, const sc_dt::sc_lv_base &, const std::string &);
103 void sc_trace(sc_trace_file *, const sc_dt::sc_lv_base *, const std::string &);
104 void sc_trace(sc_trace_file *, const sc_dt::sc_fxval &, const std::string &);
105 void sc_trace(sc_trace_file *, const sc_dt::sc_fxval *, 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_fxval_fast *,
109  const std::string &);
110 void sc_trace(sc_trace_file *, const sc_dt::sc_fxnum &, const std::string &);
111 void sc_trace(sc_trace_file *, const sc_dt::sc_fxnum *, const std::string &);
112 void sc_trace(sc_trace_file *, const sc_dt::sc_fxnum_fast &,
113  const std::string &);
114 void sc_trace(sc_trace_file *, const sc_dt::sc_fxnum_fast *,
115  const std::string &);
116 
117 
118 // Nonstandard
119 // sc_trace overloads for sc_event and sc_time.
120 void sc_trace(sc_trace_file *, const sc_event &, const std::string &);
121 void sc_trace(sc_trace_file *, const sc_event *, const std::string &);
122 void sc_trace(sc_trace_file *, const sc_time &, const std::string &);
123 void sc_trace(sc_trace_file *, const sc_time *, const std::string &);
124 
125 
126 // Nonstandard - unsigned versions necessary to avoid ambiguous overload
127 // resolution.
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 char *,
131  const std::string &, int width=(8 * sizeof(unsigned char)));
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 short *,
135  const std::string &, int width=(8 * sizeof(unsigned short)));
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 int *,
139  const std::string &, int width=(8 * sizeof(unsigned int)));
140 void sc_trace(sc_trace_file *, const unsigned long &,
141  const std::string &, int width=(8 * sizeof(unsigned long)));
142 void sc_trace(sc_trace_file *, const unsigned long *,
143  const std::string &, int width=(8 * sizeof(unsigned long)));
144 
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 char *,
148  const std::string &, int width=(8 * sizeof(char)));
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 short *,
152  const std::string &, int width=(8 * sizeof(short)));
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 int *,
156  const std::string &, int width=(8 * sizeof(int)));
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 long *,
160  const std::string &, int width=(8 * sizeof(long)));
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::int64 *,
164  const std::string &, int width=(8 * sizeof(sc_dt::int64)));
165 void sc_trace(sc_trace_file *, const sc_dt::uint64 &,
166  const std::string &, int width=(8 * sizeof(sc_dt::uint64)));
167 void sc_trace(sc_trace_file *, const sc_dt::uint64 *,
168  const std::string &, int width=(8 * sizeof(sc_dt::uint64)));
169 
170 // Nonstandard function for enums
171 void sc_trace(sc_trace_file *, const unsigned int &,
172  const std::string &, const char **enum_literals);
173 
174 // Deprecated
175 void sc_trace_delta_cycles(sc_trace_file *, bool on=true);
176 
177 template <class T>
178 void
179 sc_trace(sc_trace_file *tf, const sc_signal_in_if<T> &iface,
180  const std::string &name)
181 {
182  sc_trace(tf, iface.read(), name);
183 }
184 
185 void sc_trace(sc_trace_file *, const sc_signal_in_if<char> &,
186  const std::string &, int width);
187 
188 void sc_trace(sc_trace_file *, const sc_signal_in_if<short> &,
189  const std::string &, int width);
190 
191 void sc_trace(sc_trace_file *, const sc_signal_in_if<int> &,
192  const std::string &, int width);
193 
194 void sc_trace(sc_trace_file *, const sc_signal_in_if<long> &,
195  const std::string &, int width);
196 
197 } // namespace sc_core
198 
199 #endif //__SYSTEMC_EXT_UTIL_SC_TRACE_FILE_HH__
sc_core::sc_time
Definition: sc_time.hh:51
name
const std::string & name()
Definition: trace.cc:54
sc_core::sc_create_vcd_trace_file
sc_trace_file * sc_create_vcd_trace_file(const char *name)
Definition: sc_trace_file.cc:55
sc_core::sc_time_unit
sc_time_unit
Definition: sc_time.hh:42
sc_dt::sc_logic
Definition: sc_logic.hh:98
sc_dt::sc_fxnum_fast
Definition: sc_fxnum.hh:844
sc_core::sc_trace_file
Definition: sc_trace_file.hh:63
sc_core::sc_write_comment
void sc_write_comment(sc_trace_file *tf, const std::string &comment)
Definition: sc_trace_file.cc:71
sc_core::sc_signal_in_if::read
virtual const T & read() const =0
sc_dt
Definition: sc_bit.cc:67
sc_dt::sc_fxnum
Definition: sc_fxnum.hh:483
sc_dt::sc_int_base
Definition: sc_int_base.hh:494
sc_dt::int64
int64_t int64
Definition: sc_nbdefs.hh:171
sc_core
Definition: messages.cc:33
sc_core::sc_event
Definition: sc_event.hh:171
sc_dt::sc_lv_base
Definition: sc_lv_base.hh:84
sc_dt::sc_fxval_fast
Definition: sc_fxval.hh:376
sc_fxval
#define sc_fxval
Definition: fx_precision_double.h:65
sc_dt::sc_fxval
Definition: sc_fxval.hh:86
sc_dt::sc_unsigned
Definition: sc_unsigned.hh:890
sc_core::sc_signal_in_if
Definition: sc_signal_in_if.hh:55
sc_dt::sc_uint_base
Definition: sc_uint_base.hh:465
sc_dt::uint64
uint64_t uint64
Definition: sc_nbdefs.hh:172
sc_dt::sc_signed
Definition: sc_signed.hh:984
ArmISA::width
Bitfield< 4 > width
Definition: miscregs_types.hh:71
X86ISA::tf
Bitfield< 8 > tf
Definition: misc.hh:571
sc_core::sc_trace_delta_cycles
void sc_trace_delta_cycles(sc_trace_file *, bool on=true)
Definition: sc_trace_file.cc:459
sc_core::sc_close_vcd_trace_file
void sc_close_vcd_trace_file(sc_trace_file *tf)
Definition: sc_trace_file.cc:63
sc_dt::sc_bv_base
Definition: sc_bv_base.hh:74
sc_core::sc_trace
void sc_trace(sc_trace_file *, const sc_signal_in_if< long > &, const std::string &, int width)
Definition: sc_trace_file.cc:443
MipsISA::on
Bitfield< 0 > on
Definition: dt_constants.hh:89
Generated on Fri Feb 28 2020 16:27:04 for gem5 by doxygen 1.8.13