trace.cc revision 10292 
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
42using namespace std;
43
44namespace Trace {
45
46const string DefaultName("global");
47bool enabled = false;
48
49//
50// This variable holds the output stream for debug information.  Other
51// than setting up/redirecting this stream, do *NOT* reference this
52// directly; use DebugOut() (see below) to access this stream for
53// output.
54//
55ostream *dprintf_stream = &cerr;
56ostream &
57output()
58{
59    return *dprintf_stream;
60}
61
62void
63setOutput(const string &filename)
64{
65    dprintf_stream = simout.find(filename);
66    if (!dprintf_stream)
67        dprintf_stream = simout.create(filename);
68}
69
70ObjectMatch ignore;
71
72
73bool
74__dprintf_prologue(Tick when, const std::string &name)
75{
76    if (!name.empty() && ignore.match(name))
77        return false;
78
79    std::ostream &os = *dprintf_stream;
80
81    if (when != MaxTick)
82        ccprintf(os, "%7d: ", when);
83
84    if (!name.empty())
85        os << name << ": ";
86
87    return true;
88}
89
90void
91dump(Tick when, const std::string &name, const void *d, int len)
92{
93    const char *data = static_cast<const char *>(d);
94    std::ostream &os = *dprintf_stream;
95    int c, i, j;
96
97    for (i = 0; i < len; i += 16) {
98        if (!__dprintf_prologue(when, name))
99            return;
100
101        ccprintf(os, "%08x  ", i);
102        c = len - i;
103        if (c > 16) c = 16;
104
105        for (j = 0; j < c; j++) {
106            ccprintf(os, "%02x ", data[i + j] & 0xff);
107            if ((j & 0xf) == 7 && j > 0)
108                ccprintf(os, " ");
109        }
110
111        for (; j < 16; j++)
112            ccprintf(os, "   ");
113        ccprintf(os, "  ");
114
115        for (j = 0; j < c; j++) {
116            int ch = data[i + j] & 0x7f;
117            ccprintf(os, "%c", (char)(isprint(ch) ? ch : ' '));
118        }
119
120        ccprintf(os, "\n");
121
122        if (c < 16)
123            break;
124    }
125}
126
127} // namespace Trace
128