src/base/trace.cc

   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 #include <ctype.h>
  33 #include <fstream>
  34 #include <iostream>
  35 #include <list>
  36 #include <string>
  37 #include <vector>
  38
  39 #include "base/misc.hh"
  40 #include "base/output.hh"
  41 #include "base/str.hh"
  42 #include "base/trace.hh"
  43 #include "base/varargs.hh"
  44
  45 using namespace std;
  46
  47 namespace Trace {
  48 const string DefaultName("global");
  49 FlagVec flags(NumFlags, false);
  50 bool enabled = false;
  51
  52 //
  53 // This variable holds the output stream for debug information.  Other
  54 // than setting up/redirecting this stream, do *NOT* reference this
  55 // directly; use DebugOut() (see below) to access this stream for
  56 // output.
  57 //
  58 ostream *dprintf_stream = &cerr;
  59 ostream &
  60 output()
  61 {
  62     return *dprintf_stream;
  63 }
  64
  65 void
  66 setOutput(const string &filename)
  67 {
  68     dprintf_stream = simout.find(filename);
  69 }
  70
  71 ObjectMatch ignore;
  72
  73 void
  74 dprintf(Tick when, const std::string &name, const char *format,
  75         CPRINTF_DEFINITION)
  76 {
  77     if (!name.empty() && ignore.match(name))
  78         return;
  79
  80     std::ostream &os = *dprintf_stream;
  81
  82     string fmt = "";
  83     CPrintfArgsList args(VARARGS_ALLARGS);
  84
  85     if (!name.empty()) {
  86         fmt = "%s: " + fmt;
  87         args.push_front(name);
  88     }
  89
  90     if (when != (Tick)-1) {
  91         fmt = "%7d: " + fmt;
  92         args.push_front(when);
  93     }
  94
  95     fmt += format;
  96
  97     ccprintf(os, fmt.c_str(), args);
  98     os.flush();
  99 }
 100
 101 void
 102 dump(Tick when, const std::string &name, const void *d, int len)
 103 {
 104     if (!name.empty() && ignore.match(name))
 105         return;
 106
 107     std::ostream &os = *dprintf_stream;
 108
 109     string fmt = "";
 110     CPrintfArgsList args;
 111
 112     if (!name.empty()) {
 113         fmt = "%s: " + fmt;
 114         args.push_front(name);
 115     }
 116
 117     if (when != (Tick)-1) {
 118         fmt = "%7d: " + fmt;
 119         args.push_front(when);
 120     }
 121
 122     const char *data = static_cast<const char *>(d);
 123     int c, i, j;
 124     for (i = 0; i < len; i += 16) {
 125         ccprintf(os, fmt, args);
 126         ccprintf(os, "%08x  ", i);
 127         c = len - i;
 128         if (c > 16) c = 16;
 129
 130         for (j = 0; j < c; j++) {
 131             ccprintf(os, "%02x ", data[i + j] & 0xff);
 132             if ((j & 0xf) == 7 && j > 0)
 133                 ccprintf(os, " ");
 134         }
 135
 136         for (; j < 16; j++)
 137             ccprintf(os, "   ");
 138         ccprintf(os, "  ");
 139
 140         for (j = 0; j < c; j++) {
 141             int ch = data[i + j] & 0x7f;
 142             ccprintf(os, "%c", (char)(isprint(ch) ? ch : ' '));
 143         }
 144
 145         ccprintf(os, "\n");
 146
 147         if (c < 16)
 148             break;
 149     }
 150 }
 151
 152 bool
 153 changeFlag(const char *s, bool value)
 154 {
 155     using namespace Trace;
 156     std::string str(s);
 157
 158     for (int i = 0; i < numFlagStrings; ++i) {
 159         if (str != flagStrings[i])
 160             continue;
 161
 162         if (i < NumFlags) {
 163             flags[i] = value;
 164         } else {
 165             i -= NumFlags;
 166
 167             const Flags *flagVec = compoundFlags[i];
 168             for (int j = 0; flagVec[j] != -1; ++j) {
 169                 if (flagVec[j] < NumFlags)
 170                     flags[flagVec[j]] = value;
 171             }
 172         }
 173
 174         return true;
 175     }
 176
 177     // the flag was not found.
 178     return false;
 179 }
 180
 181 void
 182 dumpStatus()
 183 {
 184     using namespace Trace;
 185     for (int i = 0; i < numFlagStrings; ++i) {
 186         if (flags[i])
 187             cprintf("%s\n", flagStrings[i]);
 188     }
 189 }
 190
 191 /* namespace Trace */ }
 192
 193
 194 // add a set of functions that can easily be invoked from gdb
 195 void
 196 setTraceFlag(const char *string)
 197 {
 198     Trace::changeFlag(string, true);
 199 }
 200
 201 void
 202 clearTraceFlag(const char *string)
 203 {
 204     Trace::changeFlag(string, false);
 205 }
 206
 207 void
 208 dumpTraceStatus()
 209 {
 210     Trace::dumpStatus();
 211 }