2 * Copyright (c) 2001-2005 The Regents of The University of Michigan
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * Authors: Nathan Binkert
32 #ifndef __BASE_TRACE_HH__
33 #define __BASE_TRACE_HH__
37 #include "base/cprintf.hh"
38 #include "base/match.hh"
39 #include "sim/host.hh"
40 #include "sim/root.hh"
50 #include "base/traceflags.hh"
54 typedef std::vector<bool> FlagVec;
61 const bool On = false;
71 void dump(const uint8_t *data, int count);
86 virtual void dump(std::ostream &) = 0;
89 class PrintfRecord : public Record
93 const std::string &name;
97 PrintfRecord(const char *_format, cp::ArgList &_args,
98 Tick cycle, const std::string &_name)
99 : Record(cycle), format(_format), name(_name), args(_args)
103 virtual ~PrintfRecord();
105 virtual void dump(std::ostream &);
108 class DataRecord : public Record
111 const std::string &name;
116 DataRecord(Tick cycle, const std::string &name,
117 const void *_data, int _len);
118 virtual ~DataRecord();
120 virtual void dump(std::ostream &);
126 int size; // number of records in log
127 Record **buffer; // array of 'size' Record ptrs (circular buf)
128 Record **nextRecPtr; // next slot to use in buffer
129 Record **wrapRecPtr; // &buffer[size], for quick wrap check
136 void init(int _size);
138 void append(Record *); // append trace record to log
139 void dump(std::ostream &); // dump contents to stream
144 extern ObjectMatch ignore;
147 dprintf(const char *format, cp::ArgList &args, Tick cycle,
148 const std::string &name)
150 if (name.empty() || !ignore.match(name))
151 theLog.append(new Trace::PrintfRecord(format, args, cycle, name));
155 dataDump(Tick cycle, const std::string &name, const void *data, int len)
157 theLog.append(new Trace::DataRecord(cycle, name, data, len));
160 extern const std::string DefaultName;
163 // This silly little class allows us to wrap a string in a functor
164 // object so that we can give a name() that DPRINTF will like
168 StringWrap(const std::string &s) : str(s) {}
169 const std::string &operator()() const { return str; }
172 inline const std::string &name() { return Trace::DefaultName; }
173 std::ostream &DebugOut();
176 // DPRINTF is a debugging trace facility that allows one to
177 // selectively enable tracing statements. To use DPRINTF, there must
178 // be a function or functor called name() that returns a const
179 // std::string & in the current scope.
181 // If you desire that the automatic printing not occur, use DPRINTFR
187 #define DTRACE(x) (Trace::IsOn(Trace::x))
189 #define DCOUT(x) if (Trace::IsOn(Trace::x)) DebugOut()
191 #define DDUMP(x, data, count) \
193 if (Trace::IsOn(Trace::x)) \
194 Trace::dataDump(curTick, name(), data, count); \
197 #define __dprintf(cycle, name, format, args...) \
198 Trace::dprintf(format, (*(new cp::ArgList), args), cycle, name)
200 #define DPRINTF(x, args...) \
202 if (Trace::IsOn(Trace::x)) \
203 __dprintf(curTick, name(), args, cp::ArgListNull()); \
206 #define DPRINTFR(x, args...) \
208 if (Trace::IsOn(Trace::x)) \
209 __dprintf((Tick)-1, std::string(), args, cp::ArgListNull()); \
212 #define DPRINTFN(args...) \
214 __dprintf(curTick, name(), args, cp::ArgListNull()); \
217 #define DPRINTFNR(args...) \
219 __dprintf((Tick)-1, string(), args, cp::ArgListNull()); \
224 #define DTRACE(x) (false)
225 #define DCOUT(x) if (0) DebugOut()
226 #define DPRINTF(x, args...) do {} while (0)
227 #define DPRINTFR(args...) do {} while (0)
228 #define DPRINTFN(args...) do {} while (0)
229 #define DPRINTFNR(args...) do {} while (0)
230 #define DDUMP(x, data, count) do {} while (0)
234 #endif // __BASE_TRACE_HH__