trace.cc revision 8232:b28d06a175be 
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 <cctype>
33#include <fstream>
34#include <iostream>
35#include <string>
36
37#include "base/misc.hh"
38#include "base/output.hh"
39#include "base/str.hh"
40#include "base/trace.hh"
41#include "base/varargs.hh"
42
43using namespace std;
44
45namespace Trace {
46
47const string DefaultName("global");
48bool enabled = false;
49
50//
51// This variable holds the output stream for debug information.  Other
52// than setting up/redirecting this stream, do *NOT* reference this
53// directly; use DebugOut() (see below) to access this stream for
54// output.
55//
56ostream *dprintf_stream = &cerr;
57ostream &
58output()
59{
60    return *dprintf_stream;
61}
62
63void
64setOutput(const string &filename)
65{
66    dprintf_stream = simout.find(filename);
67}
68
69ObjectMatch ignore;
70
71void
72dprintf(Tick when, const std::string &name, const char *format,
73        CPRINTF_DEFINITION)
74{
75    if (!name.empty() && ignore.match(name))
76        return;
77
78    std::ostream &os = *dprintf_stream;
79
80    string fmt = "";
81    CPrintfArgsList args(VARARGS_ALLARGS);
82
83    if (!name.empty()) {
84        fmt = "%s: " + fmt;
85        args.push_front(name);
86    }
87
88    if (when != (Tick)-1) {
89        fmt = "%7d: " + fmt;
90        args.push_front(when);
91    }
92
93    fmt += format;
94
95    ccprintf(os, fmt.c_str(), args);
96    os.flush();
97}
98
99void
100dump(Tick when, const std::string &name, const void *d, int len)
101{
102    if (!name.empty() && ignore.match(name))
103        return;
104
105    std::ostream &os = *dprintf_stream;
106
107    string fmt = "";
108    CPrintfArgsList args;
109
110    if (!name.empty()) {
111        fmt = "%s: " + fmt;
112        args.push_front(name);
113    }
114
115    if (when != (Tick)-1) {
116        fmt = "%7d: " + fmt;
117        args.push_front(when);
118    }
119
120    const char *data = static_cast<const char *>(d);
121    int c, i, j;
122    for (i = 0; i < len; i += 16) {
123        ccprintf(os, fmt, args);
124        ccprintf(os, "%08x  ", i);
125        c = len - i;
126        if (c > 16) c = 16;
127
128        for (j = 0; j < c; j++) {
129            ccprintf(os, "%02x ", data[i + j] & 0xff);
130            if ((j & 0xf) == 7 && j > 0)
131                ccprintf(os, " ");
132        }
133
134        for (; j < 16; j++)
135            ccprintf(os, "   ");
136        ccprintf(os, "  ");
137
138        for (j = 0; j < c; j++) {
139            int ch = data[i + j] & 0x7f;
140            ccprintf(os, "%c", (char)(isprint(ch) ? ch : ' '));
141        }
142
143        ccprintf(os, "\n");
144
145        if (c < 16)
146            break;
147    }
148}
149
150} // namespace Trace
151