2 * Copyright (c) 2001-2006 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__
38 #include "base/cprintf.hh"
39 #include "base/match.hh"
40 #include "base/traceflags.hh"
41 #include "sim/host.hh"
42 #include "sim/root.hh"
46 std::ostream &output();
47 void setOutput(const std::string &filename);
50 typedef std::vector<bool> FlagVec;
52 inline bool IsOn(int t) { return flags[t]; }
53 bool changeFlag(const char *str, bool value);
56 extern ObjectMatch ignore;
57 extern const std::string DefaultName;
59 void dprintf(Tick when, const std::string &name, const char *format,
61 void dump(Tick when, const std::string &name, const void *data, int len);
63 /* namespace Trace */ }
65 // This silly little class allows us to wrap a string in a functor
66 // object so that we can give a name() that DPRINTF will like
70 StringWrap(const std::string &s) : str(s) {}
71 const std::string &operator()() const { return str; }
74 inline const std::string &name() { return Trace::DefaultName; }
77 // DPRINTF is a debugging trace facility that allows one to
78 // selectively enable tracing statements. To use DPRINTF, there must
79 // be a function or functor called name() that returns a const
80 // std::string & in the current scope.
82 // If you desire that the automatic printing not occur, use DPRINTFR
88 #define DTRACE(x) (Trace::IsOn(Trace::x) && Trace::enabled)
90 #define DDUMP(x, data, count) do { \
92 Trace::dump(curTick, name(), data, count); \
95 #define DPRINTF(x, ...) do { \
97 Trace::dprintf(curTick, name(), __VA_ARGS__); \
100 #define DPRINTFR(x, ...) do { \
102 Trace::dprintf((Tick)-1, std::string(), __VA_ARGS__); \
105 #define DDUMPN(data, count) do { \
106 Trace::dump(curTick, name(), data, count); \
109 #define DPRINTFN(...) do { \
110 Trace::dprintf(curTick, name(), __VA_ARGS__); \
113 #define DPRINTFNR(...) do { \
114 Trace::dprintf((Tick)-1, string(), __VA_ARGS__); \
119 #define DTRACE(x) (false)
120 #define DDUMP(x, data, count) do {} while (0)
121 #define DPRINTF(x, ...) do {} while (0)
122 #define DPRINTFR(...) do {} while (0)
123 #define DDUMPN(data, count) do {} while (0)
124 #define DPRINTFN(...) do {} while (0)
125 #define DPRINTFNR(...) do {} while (0)
129 #endif // __BASE_TRACE_HH__