sc_trace_file.hh revision 13245:c666c5d4996b 
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#include "warn_unimpl.hh"
37
38namespace sc_dt
39{
40
41class sc_logic;
42class sc_int_base;
43class sc_uint_base;
44class sc_signed;
45class sc_unsigned;
46class sc_bv_base;
47class sc_lv_base;
48class sc_fxval;
49class sc_fxval_fast;
50class sc_fxnum;
51class sc_fxnum_fast;
52
53} // namespace sc_dt
54
55namespace sc_core
56{
57
58template <class T>
59class sc_signal_in_if;
60
61class sc_event;
62class sc_time;
63
64class sc_trace_file
65{
66  protected:
67    sc_trace_file();
68
69  public:
70    virtual ~sc_trace_file();
71
72    virtual void set_time_unit(double, sc_time_unit) = 0;
73};
74
75sc_trace_file *sc_create_vcd_trace_file(const char *name);
76void sc_close_vcd_trace_file(sc_trace_file *tf);
77void sc_write_comment(sc_trace_file *tf, const std::string &comment);
78
79void sc_trace(sc_trace_file *, const bool &, const std::string &);
80void sc_trace(sc_trace_file *, const bool *, const std::string &);
81void sc_trace(sc_trace_file *, const float &, const std::string &);
82void sc_trace(sc_trace_file *, const float *, const std::string &);
83void sc_trace(sc_trace_file *, const double &, const std::string &);
84void sc_trace(sc_trace_file *, const double *, const std::string &);
85void sc_trace(sc_trace_file *, const sc_dt::sc_logic &, const std::string &);
86void sc_trace(sc_trace_file *, const sc_dt::sc_logic *, const std::string &);
87void sc_trace(sc_trace_file *, const sc_dt::sc_int_base &,
88              const std::string &);
89void sc_trace(sc_trace_file *, const sc_dt::sc_int_base *,
90              const std::string &);
91void sc_trace(sc_trace_file *, const sc_dt::sc_uint_base &,
92              const std::string &);
93void sc_trace(sc_trace_file *, const sc_dt::sc_uint_base *,
94              const std::string &);
95void sc_trace(sc_trace_file *, const sc_dt::sc_signed &, const std::string &);
96void sc_trace(sc_trace_file *, const sc_dt::sc_signed *, const std::string &);
97void sc_trace(sc_trace_file *, const sc_dt::sc_unsigned &,
98              const std::string &);
99void sc_trace(sc_trace_file *, const sc_dt::sc_unsigned *,
100              const std::string &);
101void sc_trace(sc_trace_file *, const sc_dt::sc_bv_base &, const std::string &);
102void sc_trace(sc_trace_file *, const sc_dt::sc_bv_base *, const std::string &);
103void sc_trace(sc_trace_file *, const sc_dt::sc_lv_base &, const std::string &);
104void sc_trace(sc_trace_file *, const sc_dt::sc_lv_base *, const std::string &);
105void sc_trace(sc_trace_file *, const sc_dt::sc_fxval &, const std::string &);
106void sc_trace(sc_trace_file *, const sc_dt::sc_fxval *, const std::string &);
107void sc_trace(sc_trace_file *, const sc_dt::sc_fxval_fast &,
108              const std::string &);
109void sc_trace(sc_trace_file *, const sc_dt::sc_fxval_fast *,
110              const std::string &);
111void sc_trace(sc_trace_file *, const sc_dt::sc_fxnum &, const std::string &);
112void sc_trace(sc_trace_file *, const sc_dt::sc_fxnum *, const std::string &);
113void sc_trace(sc_trace_file *, const sc_dt::sc_fxnum_fast &,
114              const std::string &);
115void sc_trace(sc_trace_file *, const sc_dt::sc_fxnum_fast *,
116              const std::string &);
117
118
119// Nonstandard
120// sc_trace overloads for sc_event and sc_time.
121void sc_trace(sc_trace_file *, const sc_event &, const std::string &);
122void sc_trace(sc_trace_file *, const sc_event *, const std::string &);
123void sc_trace(sc_trace_file *, const sc_time &, const std::string &);
124void sc_trace(sc_trace_file *, const sc_time *, const std::string &);
125
126
127// Nonstandard - unsigned versions necessary to avoid ambiguous overload
128// resolution.
129void sc_trace(sc_trace_file *, const unsigned char &,
130              const std::string &, int width=(8 * sizeof(unsigned char)));
131void sc_trace(sc_trace_file *, const unsigned char *,
132              const std::string &, int width=(8 * sizeof(unsigned char)));
133void sc_trace(sc_trace_file *, const unsigned short &,
134              const std::string &, int width=(8 * sizeof(unsigned short)));
135void sc_trace(sc_trace_file *, const unsigned short *,
136              const std::string &, int width=(8 * sizeof(unsigned short)));
137void sc_trace(sc_trace_file *, const unsigned int &,
138              const std::string &, int width=(8 * sizeof(unsigned int)));
139void sc_trace(sc_trace_file *, const unsigned int *,
140              const std::string &, int width=(8 * sizeof(unsigned int)));
141void sc_trace(sc_trace_file *, const unsigned long &,
142              const std::string &, int width=(8 * sizeof(unsigned long)));
143void sc_trace(sc_trace_file *, const unsigned long *,
144              const std::string &, int width=(8 * sizeof(unsigned long)));
145
146void sc_trace(sc_trace_file *, const char &,
147              const std::string &, int width=(8 * sizeof(char)));
148void sc_trace(sc_trace_file *, const char *,
149              const std::string &, int width=(8 * sizeof(char)));
150void sc_trace(sc_trace_file *, const short &,
151              const std::string &, int width=(8 * sizeof(short)));
152void sc_trace(sc_trace_file *, const short *,
153              const std::string &, int width=(8 * sizeof(short)));
154void sc_trace(sc_trace_file *, const int &,
155              const std::string &, int width=(8 * sizeof(int)));
156void sc_trace(sc_trace_file *, const int *,
157              const std::string &, int width=(8 * sizeof(int)));
158void sc_trace(sc_trace_file *, const long &,
159              const std::string &, int width=(8 * sizeof(long)));
160void sc_trace(sc_trace_file *, const long *,
161              const std::string &, int width=(8 * sizeof(long)));
162void sc_trace(sc_trace_file *, const sc_dt::int64 &,
163              const std::string &, int width=(8 * sizeof(sc_dt::int64)));
164void sc_trace(sc_trace_file *, const sc_dt::int64 *,
165              const std::string &, int width=(8 * sizeof(sc_dt::int64)));
166void sc_trace(sc_trace_file *, const sc_dt::uint64 &,
167              const std::string &, int width=(8 * sizeof(sc_dt::uint64)));
168void sc_trace(sc_trace_file *, const sc_dt::uint64 *,
169              const std::string &, int width=(8 * sizeof(sc_dt::uint64)));
170
171// Nonstandard function for enums
172void sc_trace(sc_trace_file *, const unsigned int &,
173              const std::string &, const char **enum_literals);
174
175// Deprecated
176void sc_trace_delta_cycles(sc_trace_file *, bool on=true);
177
178template <class T>
179void
180sc_trace(sc_trace_file *tf, const sc_signal_in_if<T> &iface,
181        const std::string &name)
182{
183    sc_trace(tf, iface.read(), name);
184}
185
186void sc_trace(sc_trace_file *, const sc_signal_in_if<char> &,
187              const std::string &, int width);
188
189void sc_trace(sc_trace_file *, const sc_signal_in_if<short> &,
190              const std::string &, int width);
191
192void sc_trace(sc_trace_file *, const sc_signal_in_if<int> &,
193              const std::string &, int width);
194
195void sc_trace(sc_trace_file *, const sc_signal_in_if<long> &,
196              const std::string &, int width);
197
198} // namespace sc_core
199
200#endif  //__SYSTEMC_EXT_UTIL_SC_TRACE_FILE_HH__
201