sc_trace_file.hh revision 12852
112027Sjungma@eit.uni-kl.de/*
212027Sjungma@eit.uni-kl.de * Copyright 2018 Google, Inc.
312027Sjungma@eit.uni-kl.de *
412027Sjungma@eit.uni-kl.de * Redistribution and use in source and binary forms, with or without
512027Sjungma@eit.uni-kl.de * modification, are permitted provided that the following conditions are
612027Sjungma@eit.uni-kl.de * met: redistributions of source code must retain the above copyright
712027Sjungma@eit.uni-kl.de * notice, this list of conditions and the following disclaimer;
812027Sjungma@eit.uni-kl.de * redistributions in binary form must reproduce the above copyright
912027Sjungma@eit.uni-kl.de * notice, this list of conditions and the following disclaimer in the
1012027Sjungma@eit.uni-kl.de * documentation and/or other materials provided with the distribution;
1112027Sjungma@eit.uni-kl.de * neither the name of the copyright holders nor the names of its
1212027Sjungma@eit.uni-kl.de * contributors may be used to endorse or promote products derived from
1312027Sjungma@eit.uni-kl.de * this software without specific prior written permission.
1412027Sjungma@eit.uni-kl.de *
1512027Sjungma@eit.uni-kl.de * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1612027Sjungma@eit.uni-kl.de * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1712027Sjungma@eit.uni-kl.de * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1812027Sjungma@eit.uni-kl.de * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
1912027Sjungma@eit.uni-kl.de * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
2012027Sjungma@eit.uni-kl.de * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
2112027Sjungma@eit.uni-kl.de * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2212027Sjungma@eit.uni-kl.de * 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
110void sc_trace(sc_trace_file *, const char &,
111              const std::string &, int width=(8 * sizeof(char)));
112void sc_trace(sc_trace_file *, const char *,
113              const std::string &, int width=(8 * sizeof(char)));
114void sc_trace(sc_trace_file *, const short &,
115              const std::string &, int width=(8 * sizeof(char)));
116void sc_trace(sc_trace_file *, const short *,
117              const std::string &, int width=(8 * sizeof(char)));
118void sc_trace(sc_trace_file *, const int &,
119              const std::string &, int width=(8 * sizeof(char)));
120void sc_trace(sc_trace_file *, const int *,
121              const std::string &, int width=(8 * sizeof(char)));
122void sc_trace(sc_trace_file *, const long &,
123              const std::string &, int width=(8 * sizeof(char)));
124void sc_trace(sc_trace_file *, const long *,
125              const std::string &, int width=(8 * sizeof(char)));
126void sc_trace(sc_trace_file *, const sc_dt::int64 &,
127              const std::string &, int width=(8 * sizeof(char)));
128void sc_trace(sc_trace_file *, const sc_dt::int64 *,
129              const std::string &, int width=(8 * sizeof(char)));
130void sc_trace(sc_trace_file *, const sc_dt::uint64 &,
131              const std::string &, int width=(8 * sizeof(char)));
132void sc_trace(sc_trace_file *, const sc_dt::uint64 *,
133              const std::string &, int width=(8 * sizeof(char)));
134
135template <class T>
136void
137sc_trace(sc_trace_file *, const sc_signal_in_if<T> &, const std::string &)
138{
139    sc_utils_warn_unimpl(__PRETTY_FUNCTION__);
140}
141
142void sc_trace(sc_trace_file *, const sc_signal_in_if<char> &,
143              const std::string &, int width);
144
145void sc_trace(sc_trace_file *, const sc_signal_in_if<short> &,
146              const std::string &, int width);
147
148void sc_trace(sc_trace_file *, const sc_signal_in_if<int> &,
149              const std::string &, int width);
150
151void sc_trace(sc_trace_file *, const sc_signal_in_if<long> &,
152              const std::string &, int width);
153
154} // namespace sc_core
155
156#endif  //__SYSTEMC_EXT_UTIL_SC_TRACE_FILE_HH__
157