2 * Copyright (c) 2014 ARM Limited
5 * Copyright (c) 2001-2006 The Regents of The University of Michigan
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met: redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer;
12 * redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution;
15 * neither the name of the copyright holders nor the names of its
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 * Authors: Nathan Binkert
36 #ifndef __BASE_TRACE_HH__
37 #define __BASE_TRACE_HH__
41 #include "base/cprintf.hh"
42 #include "base/debug.hh"
43 #include "base/match.hh"
44 #include "base/types.hh"
45 #include "sim/core.hh"
49 /** Debug logging base class. Handles formatting and outputting
50 * time/name/message messages */
54 /** Name match for objects to ignore */
58 /** Log a single message */
59 template <typename ...Args>
60 void dprintf(Tick when, const std::string &name, const char *fmt,
63 if (!name.empty() && ignore.match(name))
66 std::ostringstream line;
67 ccprintf(line, fmt, args...);
68 logMessage(when, name, line.str());
71 /** Dump a block of data of length len */
72 virtual void dump(Tick when, const std::string &name,
73 const void *d, int len);
75 /** Log formatted message */
76 virtual void logMessage(Tick when, const std::string &name,
77 const std::string &message) = 0;
79 /** Return an ostream that can be used to send messages to
80 * the 'same place' as formatted logMessage messages. This
81 * can be implemented to use a logger's underlying ostream,
82 * to provide an ostream which formats the output in some
83 * way, or just set to one of std::cout, std::cerr */
84 virtual std::ostream &getOstream() = 0;
86 /** Set objects to ignore */
87 void setIgnore(ObjectMatch &ignore_) { ignore = ignore_; }
92 /** Logging wrapper for ostreams with the format:
93 * <when>: <name>: <message-body> */
94 class OstreamLogger : public Logger
100 OstreamLogger(std::ostream &stream_) : stream(stream_)
103 void logMessage(Tick when, const std::string &name,
104 const std::string &message) override;
106 std::ostream &getOstream() override { return stream; }
109 /** Get the current global debug logger. This takes ownership of the given
110 * logger which should be allocated using 'new' */
111 Logger *getDebugLogger();
113 /** Get the ostream from the current global logger */
114 std::ostream &output();
116 /** Delete the current global logger and assign a new one */
117 void setDebugLogger(Logger *logger);
119 /** Enable/disable debug logging */
125 // This silly little class allows us to wrap a string in a functor
126 // object so that we can give a name() that DPRINTF will like
130 StringWrap(const std::string &s) : str(s) {}
131 const std::string &operator()() const { return str; }
134 // Return the global context name "global". This function gets called when
135 // the DPRINTF macros are used in a context without a visible name() function
136 const std::string &name();
138 // Interface for things with names. (cf. SimObject but without other
139 // functionality). This is useful when using DPRINTF
143 const std::string _name;
146 Named(const std::string &name_) : _name(name_) { }
149 const std::string &name() const { return _name; }
153 // DPRINTF is a debugging trace facility that allows one to
154 // selectively enable tracing statements. To use DPRINTF, there must
155 // be a function or functor called name() that returns a const
156 // std::string & in the current scope.
158 // If you desire that the automatic printing not occur, use DPRINTFR
164 #define DTRACE(x) (Debug::x)
166 #define DDUMP(x, data, count) do { \
167 using namespace Debug; \
169 Trace::getDebugLogger()->dump(curTick(), name(), data, count); \
172 #define DPRINTF(x, ...) do { \
173 using namespace Debug; \
175 Trace::getDebugLogger()->dprintf(curTick(), name(), \
180 #define DPRINTFS(x, s, ...) do { \
181 using namespace Debug; \
183 Trace::getDebugLogger()->dprintf(curTick(), s->name(), \
188 #define DPRINTFR(x, ...) do { \
189 using namespace Debug; \
191 Trace::getDebugLogger()->dprintf((Tick)-1, std::string(), \
196 #define DDUMPN(data, count) do { \
197 Trace::getDebugLogger()->dump(curTick(), name(), data, count); \
200 #define DPRINTFN(...) do { \
201 Trace::getDebugLogger()->dprintf(curTick(), name(), __VA_ARGS__); \
204 #define DPRINTFNR(...) do { \
205 Trace::getDebugLogger()->dprintf((Tick)-1, string(), __VA_ARGS__); \
210 #define DTRACE(x) (false)
211 #define DDUMP(x, data, count) do {} while (0)
212 #define DPRINTF(x, ...) do {} while (0)
213 #define DPRINTFS(x, ...) do {} while (0)
214 #define DPRINTFR(...) do {} while (0)
215 #define DDUMPN(data, count) do {} while (0)
216 #define DPRINTFN(...) do {} while (0)
217 #define DPRINTFNR(...) do {} while (0)
221 #endif // __BASE_TRACE_HH__