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