1/*
2 * Copyright (c) 2014 ARM Limited
3 * All rights reserved
4 *
5 * Copyright (c) 2001-2006 The Regents of The University of Michigan
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met: redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer;
12 * redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution;
15 * neither the name of the copyright holders nor the names of its
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 *
31 * Authors: Nathan Binkert
32 *          Steve Reinhardt
33 *          Andrew Bardsley
34 */
35
36#include "base/trace.hh"
37
38#include <cctype>
39#include <fstream>
40#include <iostream>
41#include <sstream>
42#include <string>
43
44#include "base/debug.hh"
45#include "base/logging.hh"
46#include "base/output.hh"
47#include "base/str.hh"
48
49const std::string &name()
50{
51    static const std::string default_name("global");
52
53    return default_name;
54}
55
56namespace Trace
57{
58
59// This variable holds the output logger for debug information.  Other
60// than setting up/redirecting this logger, do *NOT* reference this
61// directly
62
63Logger *debug_logger = NULL;
64
65Logger *
66getDebugLogger()
67{
68    /* Set a default logger to cerr when no other logger is set */
69    if (!debug_logger)
70        debug_logger = new OstreamLogger(std::cerr);
71
72    return debug_logger;
73}
74
75std::ostream &
76output()
77{
78    return getDebugLogger()->getOstream();
79}
80
81void
82setDebugLogger(Logger *logger)
83{
84    if (!logger)
85        warn("Trying to set debug logger to NULL\n");
86    else
87        debug_logger = logger;
88}
89
90void
91enable()
92{
93    Debug::SimpleFlag::enableAll();
94}
95
96void
97disable()
98{
99    Debug::SimpleFlag::disableAll();
100}
101
102ObjectMatch ignore;
103
104void
105Logger::dump(Tick when, const std::string &name, const void *d, int len)
106{
107    if (!name.empty() && ignore.match(name))
108        return;
109
110    const char *data = static_cast<const char *>(d);
111    int c, i, j;
112
113    for (i = 0; i < len; i += 16) {
114        std::ostringstream line;
115
116        ccprintf(line, "%08x  ", i);
117        c = len - i;
118        if (c > 16) c = 16;
119
120        for (j = 0; j < c; j++) {
121            ccprintf(line, "%02x ", data[i + j] & 0xff);
122            if ((j & 0xf) == 7 && j > 0)
123                ccprintf(line, " ");
124        }
125
126        for (; j < 16; j++)
127            ccprintf(line, "   ");
128        ccprintf(line, "  ");
129
130        for (j = 0; j < c; j++) {
131            int ch = data[i + j] & 0x7f;
132            ccprintf(line, "%c", (char)(isprint(ch) ? ch : ' '));
133        }
134
135        ccprintf(line, "\n");
136        logMessage(when, name, line.str());
137
138        if (c < 16)
139            break;
140    }
141}
142
143void
144OstreamLogger::logMessage(Tick when, const std::string &name,
145                          const std::string &message)
146{
147    if (!name.empty() && ignore.match(name))
148        return;
149
150    if (when != MaxTick)
151        ccprintf(stream, "%7d: ", when);
152
153    if (!name.empty())
154        stream << name << ": ";
155
156    stream << message;
157    stream.flush();
158}
159
160} // namespace Trace
161