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