* Copyright (c) 2014 ARM Limited
* All rights reserved
*
- * The license below extends only to copyright in the software and shall
- * not be construed as granting a license to any other intellectual
- * property including but not limited to intellectual property relating
- * to a hardware implementation of the functionality of the software
- * licensed hereunder. You may use the software subject to the license
- * terms below provided that you ensure that this notice is replicated
- * unmodified and in its entirety in all distributions of the software,
- * modified or unmodified, in source code or in binary form.
- *
* Copyright (c) 2001-2006 The Regents of The University of Michigan
* All rights reserved.
*
*
* Authors: Nathan Binkert
* Steve Reinhardt
+ * Andrew Bardsley
*/
#ifndef __BASE_TRACE_HH__
namespace Trace {
-using Debug::SimpleFlag;
-using Debug::CompoundFlag;
+/** Debug logging base class. Handles formatting and outputting
+ * time/name/message messages */
+class Logger
+{
+ protected:
+ /** Name match for objects to ignore */
+ ObjectMatch ignore;
-std::ostream &output();
-void setOutput(const std::string &filename);
+ public:
+ /** Log a single message */
+ template <typename ...Args>
+ void dprintf(Tick when, const std::string &name, const char *fmt,
+ const Args &...args)
+ {
+ if (!name.empty() && ignore.match(name))
+ return;
+
+ std::ostringstream line;
+ ccprintf(line, fmt, args...);
+ logMessage(when, name, line.str());
+ }
+
+ /** Dump a block of data of length len */
+ virtual void dump(Tick when, const std::string &name,
+ const void *d, int len);
+
+ /** Log formatted message */
+ virtual void logMessage(Tick when, const std::string &name,
+ const std::string &message) = 0;
+
+ /** Return an ostream that can be used to send messages to
+ * the 'same place' as formatted logMessage messages. This
+ * can be implemented to use a logger's underlying ostream,
+ * to provide an ostream which formats the output in some
+ * way, or just set to one of std::cout, std::cerr */
+ virtual std::ostream &getOstream() = 0;
+
+ /** Set objects to ignore */
+ void setIgnore(ObjectMatch &ignore_) { ignore = ignore_; }
+
+ virtual ~Logger() { }
+};
+
+/** Logging wrapper for ostreams with the format:
+ * <when>: <name>: <message-body> */
+class OstreamLogger : public Logger
+{
+ protected:
+ std::ostream &stream;
-extern bool enabled;
-bool changeFlag(const char *str, bool value);
-void dumpStatus();
+ public:
+ OstreamLogger(std::ostream &stream_) : stream(stream_)
+ { }
-extern ObjectMatch ignore;
-extern const std::string DefaultName;
+ void logMessage(Tick when, const std::string &name,
+ const std::string &message) override;
-bool __dprintf_prologue(Tick when, const std::string &name);
+ std::ostream &getOstream() override { return stream; }
+};
-template<typename ...Args> void
-dprintf(Tick when, const std::string &name, const char *format,
- const Args &...args)
-{
- if (!__dprintf_prologue(when, name))
- return;
+/** Get the current global debug logger. This takes ownership of the given
+ * logger which should be allocated using 'new' */
+Logger *getDebugLogger();
+
+/** Get the ostream from the current global logger */
+std::ostream &output();
- std::ostream &os(output());
- ccprintf(os, format, args...);
- os.flush();
-}
+/** Delete the current global logger and assign a new one */
+void setDebugLogger(Logger *logger);
-void dump(Tick when, const std::string &name, const void *data, int len);
+/** Enable/disable debug logging */
+void enable();
+void disable();
} // namespace Trace
const std::string &operator()() const { return str; }
};
-inline const std::string &name() { return Trace::DefaultName; }
+// Return the global context name "global". This function gets called when
+// the DPRINTF macros are used in a context without a visible name() function
+const std::string &name();
// Interface for things with names. (cf. SimObject but without other
// functionality). This is useful when using DPRINTF
#if TRACING_ON
-#define DTRACE(x) ((Debug::x) && Trace::enabled)
+#define DTRACE(x) (Debug::x)
-#define DDUMP(x, data, count) do { \
- using namespace Debug; \
- if (DTRACE(x)) \
- Trace::dump(curTick(), name(), data, count); \
+#define DDUMP(x, data, count) do { \
+ using namespace Debug; \
+ if (DTRACE(x)) \
+ Trace::getDebugLogger()->dump(curTick(), name(), data, count); \
} while (0)
-#define DPRINTF(x, ...) do { \
- using namespace Debug; \
- if (DTRACE(x)) \
- Trace::dprintf(curTick(), name(), __VA_ARGS__); \
+#define DPRINTF(x, ...) do { \
+ using namespace Debug; \
+ if (DTRACE(x)) { \
+ Trace::getDebugLogger()->dprintf(curTick(), name(), \
+ __VA_ARGS__); \
+ } \
} while (0)
-#define DPRINTFS(x, s, ...) do { \
- using namespace Debug; \
- if (DTRACE(x)) \
- Trace::dprintf(curTick(), s->name(), __VA_ARGS__); \
+#define DPRINTFS(x, s, ...) do { \
+ using namespace Debug; \
+ if (DTRACE(x)) { \
+ Trace::getDebugLogger()->dprintf(curTick(), s->name(), \
+ __VA_ARGS__); \
+ } \
} while (0)
-#define DPRINTFR(x, ...) do { \
- using namespace Debug; \
- if (DTRACE(x)) \
- Trace::dprintf((Tick)-1, std::string(), __VA_ARGS__); \
+#define DPRINTFR(x, ...) do { \
+ using namespace Debug; \
+ if (DTRACE(x)) { \
+ Trace::getDebugLogger()->dprintf((Tick)-1, std::string(), \
+ __VA_ARGS__); \
+ } \
} while (0)
-#define DDUMPN(data, count) do { \
- Trace::dump(curTick(), name(), data, count); \
+#define DDUMPN(data, count) do { \
+ Trace::getDebugLogger()->dump(curTick(), name(), data, count); \
} while (0)
-#define DPRINTFN(...) do { \
- Trace::dprintf(curTick(), name(), __VA_ARGS__); \
+#define DPRINTFN(...) do { \
+ Trace::getDebugLogger()->dprintf(curTick(), name(), __VA_ARGS__); \
} while (0)
-#define DPRINTFNR(...) do { \
- Trace::dprintf((Tick)-1, string(), __VA_ARGS__); \
+#define DPRINTFNR(...) do { \
+ Trace::getDebugLogger()->dprintf((Tick)-1, string(), __VA_ARGS__); \
} while (0)
#else // !TRACING_ON
projects / gem5.git / blobdiff