sc_trace_file.hh revision 13335:299a16ef8e3c
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 37namespace sc_dt 38{ 39 40class sc_logic; 41class sc_int_base; 42class sc_uint_base; 43class sc_signed; 44class sc_unsigned; 45class sc_bv_base; 46class sc_lv_base; 47class sc_fxval; 48class sc_fxval_fast; 49class sc_fxnum; 50class sc_fxnum_fast; 51 52} // namespace sc_dt 53 54namespace sc_core 55{ 56 57template <class T> 58class sc_signal_in_if; 59 60class sc_event; 61class sc_time; 62 63class 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 74sc_trace_file *sc_create_vcd_trace_file(const char *name); 75void sc_close_vcd_trace_file(sc_trace_file *tf); 76void sc_write_comment(sc_trace_file *tf, const std::string &comment); 77 78void sc_trace(sc_trace_file *, const bool &, const std::string &); 79void sc_trace(sc_trace_file *, const bool *, const std::string &); 80void sc_trace(sc_trace_file *, const float &, const std::string &); 81void sc_trace(sc_trace_file *, const float *, const std::string &); 82void sc_trace(sc_trace_file *, const double &, const std::string &); 83void sc_trace(sc_trace_file *, const double *, const std::string &); 84void sc_trace(sc_trace_file *, const sc_dt::sc_logic &, 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_int_base &, 87 const std::string &); 88void sc_trace(sc_trace_file *, const sc_dt::sc_int_base *, 89 const std::string &); 90void sc_trace(sc_trace_file *, const sc_dt::sc_uint_base &, 91 const std::string &); 92void sc_trace(sc_trace_file *, const sc_dt::sc_uint_base *, 93 const std::string &); 94void sc_trace(sc_trace_file *, const sc_dt::sc_signed &, 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_unsigned &, 97 const std::string &); 98void sc_trace(sc_trace_file *, const sc_dt::sc_unsigned *, 99 const std::string &); 100void sc_trace(sc_trace_file *, const sc_dt::sc_bv_base &, 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_lv_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_fxval &, 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_fast &, 107 const std::string &); 108void sc_trace(sc_trace_file *, const sc_dt::sc_fxval_fast *, 109 const std::string &); 110void sc_trace(sc_trace_file *, const sc_dt::sc_fxnum &, 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_fast &, 113 const std::string &); 114void 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. 120void sc_trace(sc_trace_file *, const sc_event &, const std::string &); 121void sc_trace(sc_trace_file *, const sc_event *, const std::string &); 122void sc_trace(sc_trace_file *, const sc_time &, const std::string &); 123void sc_trace(sc_trace_file *, const sc_time *, const std::string &); 124 125 126// Nonstandard - unsigned versions necessary to avoid ambiguous overload 127// resolution. 128void sc_trace(sc_trace_file *, const unsigned char &, 129 const std::string &, int width=(8 * sizeof(unsigned char))); 130void sc_trace(sc_trace_file *, const unsigned char *, 131 const std::string &, int width=(8 * sizeof(unsigned char))); 132void sc_trace(sc_trace_file *, const unsigned short &, 133 const std::string &, int width=(8 * sizeof(unsigned short))); 134void sc_trace(sc_trace_file *, const unsigned short *, 135 const std::string &, int width=(8 * sizeof(unsigned short))); 136void sc_trace(sc_trace_file *, const unsigned int &, 137 const std::string &, int width=(8 * sizeof(unsigned int))); 138void sc_trace(sc_trace_file *, const unsigned int *, 139 const std::string &, int width=(8 * sizeof(unsigned int))); 140void sc_trace(sc_trace_file *, const unsigned long &, 141 const std::string &, int width=(8 * sizeof(unsigned long))); 142void sc_trace(sc_trace_file *, const unsigned long *, 143 const std::string &, int width=(8 * sizeof(unsigned long))); 144 145void sc_trace(sc_trace_file *, const char &, 146 const std::string &, int width=(8 * sizeof(char))); 147void sc_trace(sc_trace_file *, const char *, 148 const std::string &, int width=(8 * sizeof(char))); 149void sc_trace(sc_trace_file *, const short &, 150 const std::string &, int width=(8 * sizeof(short))); 151void sc_trace(sc_trace_file *, const short *, 152 const std::string &, int width=(8 * sizeof(short))); 153void sc_trace(sc_trace_file *, const int &, 154 const std::string &, int width=(8 * sizeof(int))); 155void sc_trace(sc_trace_file *, const int *, 156 const std::string &, int width=(8 * sizeof(int))); 157void sc_trace(sc_trace_file *, const long &, 158 const std::string &, int width=(8 * sizeof(long))); 159void sc_trace(sc_trace_file *, const long *, 160 const std::string &, int width=(8 * sizeof(long))); 161void sc_trace(sc_trace_file *, const sc_dt::int64 &, 162 const std::string &, int width=(8 * sizeof(sc_dt::int64))); 163void sc_trace(sc_trace_file *, const sc_dt::int64 *, 164 const std::string &, int width=(8 * sizeof(sc_dt::int64))); 165void sc_trace(sc_trace_file *, const sc_dt::uint64 &, 166 const std::string &, int width=(8 * sizeof(sc_dt::uint64))); 167void 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 171void sc_trace(sc_trace_file *, const unsigned int &, 172 const std::string &, const char **enum_literals); 173 174// Deprecated 175void sc_trace_delta_cycles(sc_trace_file *, bool on=true); 176 177template <class T> 178void 179sc_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 185void sc_trace(sc_trace_file *, const sc_signal_in_if<char> &, 186 const std::string &, int width); 187 188void sc_trace(sc_trace_file *, const sc_signal_in_if<short> &, 189 const std::string &, int width); 190 191void sc_trace(sc_trace_file *, const sc_signal_in_if<int> &, 192 const std::string &, int width); 193 194void 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__ 200