trace.hh revision 5806:130e19359857
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#include <vector> 37 38#include "base/cprintf.hh" 39#include "base/match.hh" 40#include "base/traceflags.hh" 41#include "sim/host.hh" 42#include "sim/core.hh" 43 44namespace Trace { 45 46std::ostream &output(); 47void setOutput(const std::string &filename); 48 49extern bool enabled; 50typedef std::vector<bool> FlagVec; 51extern FlagVec flags; 52inline bool IsOn(int t) { return flags[t]; } 53bool changeFlag(const char *str, bool value); 54void dumpStatus(); 55 56extern ObjectMatch ignore; 57extern const std::string DefaultName; 58 59void dprintf(Tick when, const std::string &name, const char *format, 60 CPRINTF_DECLARATION); 61void dump(Tick when, const std::string &name, const void *data, int len); 62 63/* namespace Trace */ } 64 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 67struct StringWrap 68{ 69 std::string str; 70 StringWrap(const std::string &s) : str(s) {} 71 const std::string &operator()() const { return str; } 72}; 73 74inline const std::string &name() { return Trace::DefaultName; } 75 76// 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. 81// 82// If you desire that the automatic printing not occur, use DPRINTFR 83// (R for raw) 84// 85 86#if TRACING_ON 87 88#define DTRACE(x) (Trace::IsOn(Trace::x) && Trace::enabled) 89 90#define DDUMP(x, data, count) do { \ 91 if (DTRACE(x)) \ 92 Trace::dump(curTick, name(), data, count); \ 93} while (0) 94 95#define DPRINTF(x, ...) do { \ 96 if (DTRACE(x)) \ 97 Trace::dprintf(curTick, name(), __VA_ARGS__); \ 98} while (0) 99 100#define DPRINTFS(x,s, ...) do { \ 101 if (DTRACE(x)) \ 102 Trace::dprintf(curTick, s->name(), __VA_ARGS__); \ 103} while (0) 104 105 106#define DPRINTFR(x, ...) do { \ 107 if (DTRACE(x)) \ 108 Trace::dprintf((Tick)-1, std::string(), __VA_ARGS__); \ 109} while (0) 110 111#define DDUMPN(data, count) do { \ 112 Trace::dump(curTick, name(), data, count); \ 113} while (0) 114 115#define DPRINTFN(...) do { \ 116 Trace::dprintf(curTick, name(), __VA_ARGS__); \ 117} while (0) 118 119#define DPRINTFNR(...) do { \ 120 Trace::dprintf((Tick)-1, string(), __VA_ARGS__); \ 121} while (0) 122 123#else // !TRACING_ON 124 125#define DTRACE(x) (false) 126#define DDUMP(x, data, count) do {} while (0) 127#define DPRINTF(x, ...) do {} while (0) 128#define DPRINTFS(x, ...) do {} while (0) 129#define DPRINTFR(...) do {} while (0) 130#define DDUMPN(data, count) do {} while (0) 131#define DPRINTFN(...) do {} while (0) 132#define DPRINTFNR(...) do {} while (0) 133 134#endif // TRACING_ON 135 136#endif // __BASE_TRACE_HH__ 137