trace.hh revision 10259
1/* 2 * Copyright (c) 2001-2006 The Regents of The University of Michigan 3 * All rights reserved. 4 * 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. 15 * 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. 27 * 28 * Authors: Nathan Binkert 29 * Steve Reinhardt 30 */ 31 32#ifndef __BASE_TRACE_HH__ 33#define __BASE_TRACE_HH__ 34 35#include <string> 36 37#include "base/cprintf.hh" 38#include "base/debug.hh" 39#include "base/match.hh" 40#include "base/types.hh" 41#include "sim/core.hh" 42 43namespace Trace { 44 45using Debug::SimpleFlag; 46using Debug::CompoundFlag; 47 48std::ostream &output(); 49void setOutput(const std::string &filename); 50 51extern bool enabled; 52bool changeFlag(const char *str, bool value); 53void dumpStatus(); 54 55extern ObjectMatch ignore; 56extern const std::string DefaultName; 57 58void dprintf(Tick when, const std::string &name, const char *format, 59 CPRINTF_DECLARATION); 60void dump(Tick when, const std::string &name, const void *data, int len); 61 62} // namespace Trace 63 64// This silly little class allows us to wrap a string in a functor 65// object so that we can give a name() that DPRINTF will like 66struct StringWrap 67{ 68 std::string str; 69 StringWrap(const std::string &s) : str(s) {} 70 const std::string &operator()() const { return str; } 71}; 72 73inline const std::string &name() { return Trace::DefaultName; } 74 75// Interface for things with names. (cf. SimObject but without other 76// functionality). This is useful when using DPRINTF 77class Named 78{ 79 protected: 80 const std::string _name; 81 82 public: 83 Named(const std::string &name_) : _name(name_) { } 84 85 public: 86 const std::string &name() const { return _name; } 87}; 88 89// 90// DPRINTF is a debugging trace facility that allows one to 91// selectively enable tracing statements. To use DPRINTF, there must 92// be a function or functor called name() that returns a const 93// std::string & in the current scope. 94// 95// If you desire that the automatic printing not occur, use DPRINTFR 96// (R for raw) 97// 98 99#if TRACING_ON 100 101#define DTRACE(x) ((Debug::x) && Trace::enabled) 102 103#define DDUMP(x, data, count) do { \ 104 using namespace Debug; \ 105 if (DTRACE(x)) \ 106 Trace::dump(curTick(), name(), data, count); \ 107} while (0) 108 109#define DPRINTF(x, ...) do { \ 110 using namespace Debug; \ 111 if (DTRACE(x)) \ 112 Trace::dprintf(curTick(), name(), __VA_ARGS__); \ 113} while (0) 114 115#define DPRINTFS(x, s, ...) do { \ 116 using namespace Debug; \ 117 if (DTRACE(x)) \ 118 Trace::dprintf(curTick(), s->name(), __VA_ARGS__); \ 119} while (0) 120 121#define DPRINTFR(x, ...) do { \ 122 using namespace Debug; \ 123 if (DTRACE(x)) \ 124 Trace::dprintf((Tick)-1, std::string(), __VA_ARGS__); \ 125} while (0) 126 127#define DDUMPN(data, count) do { \ 128 Trace::dump(curTick(), name(), data, count); \ 129} while (0) 130 131#define DPRINTFN(...) do { \ 132 Trace::dprintf(curTick(), name(), __VA_ARGS__); \ 133} while (0) 134 135#define DPRINTFNR(...) do { \ 136 Trace::dprintf((Tick)-1, string(), __VA_ARGS__); \ 137} while (0) 138 139#else // !TRACING_ON 140 141#define DTRACE(x) (false) 142#define DDUMP(x, data, count) do {} while (0) 143#define DPRINTF(x, ...) do {} while (0) 144#define DPRINTFS(x, ...) do {} while (0) 145#define DPRINTFR(...) do {} while (0) 146#define DDUMPN(data, count) do {} while (0) 147#define DPRINTFN(...) do {} while (0) 148#define DPRINTFNR(...) do {} while (0) 149 150#endif // TRACING_ON 151 152#endif // __BASE_TRACE_HH__ 153