X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=src%2Fbase%2Ftrace.hh;h=ddf936ecd72e89e8e81c599f22d1f365fe2865f3;hb=97887eb6dc9e548c9b5719727fd4783ef157917c;hp=55dd1bd4eac0c7df9fee93da1ffdf6d0f80ee878;hpb=1f834b569c8a39f44882c2f2010a9f0ecffdaab1;p=gem5.git diff --git a/src/base/trace.hh b/src/base/trace.hh index 55dd1bd4e..ddf936ecd 100644 --- a/src/base/trace.hh +++ b/src/base/trace.hh @@ -1,4 +1,7 @@ /* + * Copyright (c) 2014 ARM Limited + * All rights reserved + * * Copyright (c) 2001-2006 The Regents of The University of Michigan * All rights reserved. * @@ -27,136 +30,97 @@ * * Authors: Nathan Binkert * Steve Reinhardt + * Andrew Bardsley */ #ifndef __BASE_TRACE_HH__ #define __BASE_TRACE_HH__ -#include +#include #include "base/cprintf.hh" +#include "base/debug.hh" #include "base/match.hh" -#include "sim/host.hh" -#include "sim/root.hh" - -#include "base/traceflags.hh" +#include "base/types.hh" +#include "sim/core.hh" namespace Trace { - typedef std::vector FlagVec; - - extern FlagVec flags; - -#if TRACING_ON - const bool On = true; -#else - const bool On = false; -#endif - - inline bool - IsOn(int t) +/** Debug logging base class. Handles formatting and outputting + * time/name/message messages */ +class Logger +{ + protected: + /** Name match for objects to ignore */ + ObjectMatch ignore; + + public: + /** Log a single message */ + template + void dprintf(Tick when, const std::string &name, const char *fmt, + const Args &...args) { - return flags[t]; + if (!name.empty() && ignore.match(name)) + return; + std::ostringstream line; + ccprintf(line, fmt, args...); + logMessage(when, name, line.str()); } - void dump(const uint8_t *data, int count); - - class Record - { - protected: - Tick cycle; - - Record(Tick _cycle) - : cycle(_cycle) - { - } - - public: - virtual ~Record() {} - - virtual void dump(std::ostream &) = 0; - }; - - class PrintfRecord : public Record - { - private: - const std::string &name; - const char *format; - CPrintfArgsList args; - - public: - PrintfRecord(Tick cycle, const std::string &_name, const char *_format, - CPRINTF_DECLARATION) - : Record(cycle), name(_name), format(_format), - args(VARARGS_ALLARGS) - { - } + /** Dump a block of data of length len */ + virtual void dump(Tick when, const std::string &name, + const void *d, int len); - virtual ~PrintfRecord(); + /** Log formatted message */ + virtual void logMessage(Tick when, const std::string &name, + const std::string &message) = 0; - virtual void dump(std::ostream &); - }; + /** 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; - class DataRecord : public Record - { - private: - const std::string &name; - uint8_t *data; - int len; - - public: - DataRecord(Tick cycle, const std::string &name, - const void *_data, int _len); - virtual ~DataRecord(); - - virtual void dump(std::ostream &); - }; - - class Log - { - private: - int size; // number of records in log - Record **buffer; // array of 'size' Record ptrs (circular buf) - Record **nextRecPtr; // next slot to use in buffer - Record **wrapRecPtr; // &buffer[size], for quick wrap check + /** Set objects to ignore */ + void setIgnore(ObjectMatch &ignore_) { ignore = ignore_; } - public: - Log(); - ~Log(); - - void init(int _size); + virtual ~Logger() { } +}; - void append(Record *); // append trace record to log - void dump(std::ostream &); // dump contents to stream - }; +/** Logging wrapper for ostreams with the format: + * : : */ +class OstreamLogger : public Logger +{ + protected: + std::ostream &stream; - extern Log theLog; + public: + OstreamLogger(std::ostream &stream_) : stream(stream_) + { } - extern ObjectMatch ignore; + void logMessage(Tick when, const std::string &name, + const std::string &message) override; - inline void - dprintf(Tick when, const std::string &name, const char *format, - CPRINTF_DECLARATION) - { - if (!name.empty() && ignore.match(name)) - return; + std::ostream &getOstream() override { return stream; } +}; - theLog.append(new Trace::PrintfRecord(when, name, format, - VARARGS_ALLARGS)); - } +/** Get the current global debug logger. This takes ownership of the given + * logger which should be allocated using 'new' */ +Logger *getDebugLogger(); - inline void - dataDump(Tick when, const std::string &name, const void *data, int len) - { - theLog.append(new Trace::DataRecord(when, name, data, len)); - } +/** Get the ostream from the current global logger */ +std::ostream &output(); - extern const std::string DefaultName; +/** Delete the current global logger and assign a new one */ +void setDebugLogger(Logger *logger); -}; +/** Enable/disable debug logging */ +void enable(); +void disable(); -std::ostream &DebugOut(); +} // namespace Trace // This silly little class allows us to wrap a string in a functor // object so that we can give a name() that DPRINTF will like @@ -167,7 +131,23 @@ struct StringWrap 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 +class Named +{ + protected: + const std::string _name; + + public: + Named(const std::string &name_) : _name(name_) { } + + public: + const std::string &name() const { return _name; } +}; // // DPRINTF is a debugging trace facility that allows one to @@ -181,40 +161,61 @@ inline const std::string &name() { return Trace::DefaultName; } #if TRACING_ON -#define DTRACE(x) (Trace::IsOn(Trace::x)) +#define DTRACE(x) (Debug::x) -#define DDUMP(x, data, count) do { \ - if (DTRACE(x)) \ - Trace::dataDump(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, args...) do { \ - if (DTRACE(x)) \ - Trace::dprintf(curTick, name(), args); \ +#define DPRINTF(x, ...) do { \ + using namespace Debug; \ + if (DTRACE(x)) { \ + Trace::getDebugLogger()->dprintf(curTick(), name(), \ + __VA_ARGS__); \ + } \ } while (0) -#define DPRINTFR(x, args...) do { \ - if (DTRACE(x)) \ - Trace::dprintf((Tick)-1, std::string(), args); \ +#define DPRINTFS(x, s, ...) do { \ + using namespace Debug; \ + if (DTRACE(x)) { \ + Trace::getDebugLogger()->dprintf(curTick(), s->name(), \ + __VA_ARGS__); \ + } \ } while (0) -#define DPRINTFN(args...) do { \ - Trace::dprintf(curTick, name(), args); \ +#define DPRINTFR(x, ...) do { \ + using namespace Debug; \ + if (DTRACE(x)) { \ + Trace::getDebugLogger()->dprintf((Tick)-1, std::string(), \ + __VA_ARGS__); \ + } \ } while (0) -#define DPRINTFNR(args...) do { \ - Trace::dprintf((Tick)-1, string(), args); \ +#define DDUMPN(data, count) do { \ + Trace::getDebugLogger()->dump(curTick(), name(), data, count); \ +} while (0) + +#define DPRINTFN(...) do { \ + Trace::getDebugLogger()->dprintf(curTick(), name(), __VA_ARGS__); \ +} while (0) + +#define DPRINTFNR(...) do { \ + Trace::getDebugLogger()->dprintf((Tick)-1, string(), __VA_ARGS__); \ } while (0) #else // !TRACING_ON #define DTRACE(x) (false) -#define DPRINTF(x, args...) do {} while (0) -#define DPRINTFR(args...) do {} while (0) -#define DPRINTFN(args...) do {} while (0) -#define DPRINTFNR(args...) do {} while (0) #define DDUMP(x, data, count) do {} while (0) - -#endif // TRACING_ON +#define DPRINTF(x, ...) do {} while (0) +#define DPRINTFS(x, ...) do {} while (0) +#define DPRINTFR(...) do {} while (0) +#define DDUMPN(data, count) do {} while (0) +#define DPRINTFN(...) do {} while (0) +#define DPRINTFNR(...) do {} while (0) + +#endif // TRACING_ON #endif // __BASE_TRACE_HH__