summaryrefslogtreecommitdiff
path: root/src/mem/ruby/common/Debug.cc
blob: 1bf7ae43bdf2543e7a2ac3ba473de8d130efe22e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
/*
 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include <fstream>
#include <stdarg.h>

#include "base/misc.hh"
#include "mem/ruby/common/Debug.hh"
#include "mem/ruby/common/Global.hh"
#include "mem/ruby/eventqueue/RubyEventQueue.hh"

using namespace std;

class Debug;
extern Debug* g_debug_ptr;
ostream *debug_cout_ptr;

bool Debug::m_protocol_trace = false;
struct DebugComponentData
{
    const char *desc;
    const char ch;
};

// component character list
DebugComponentData debugComponents[] =
{
    {"System",            's' },
    {"Node",              'N' },
    {"Queue",             'q' },
    {"Event Queue",       'e' },
    {"Network",           'n' },
    {"Sequencer",         'S' },
    {"Tester",            't' },
    {"Generated",         'g' },
    {"SLICC",             'l' },
    {"Network Queues",    'Q' },
    {"Time",              'T' },
    {"Network Internals", 'i' },
    {"Store Buffer",      'b' },
    {"Cache",             'c' },
    {"Predictor",         'p' },
    {"Allocator",         'a' },
    {"Memory",            'M' },
};

extern "C" void changeDebugVerbosity(VerbosityLevel vb);
extern "C" void changeDebugFilter(int filter);

void
changeDebugVerbosity(VerbosityLevel vb)
{
    g_debug_ptr->setVerbosity(vb);
}

void
changeDebugFilter(int filter)
{
    g_debug_ptr->setFilter(filter);
}

Debug::Debug(const Params *p)
    : SimObject(p)
{
    clearFilter();
    debug_cout_ptr = &cout;

    setFilterString(p->filter_string.c_str());
    setVerbosityString(p->verbosity_string.c_str());
    setDebugOutputFile(p->output_filename.c_str());
    m_starting_cycle = p->start_time;
    m_protocol_trace = p->protocol_trace;
    g_debug_ptr = this;
}

Debug::~Debug()
{
}

void
Debug::printVerbosity(ostream& out) const
{
    switch (getVerbosity()) {
      case No_Verb:
        out << "verbosity = No_Verb" << endl;
        break;
      case Low_Verb:
        out << "verbosity = Low_Verb" << endl;
        break;
      case Med_Verb:
        out << "verbosity = Med_Verb" << endl;
        break;
      case High_Verb:
        out << "verbosity = High_Verb" << endl;
        break;
      default:
        out << "verbosity = unknown" << endl;
    }
}

bool
Debug::validDebug(int module, PriorityLevel priority)
{
    int local_module = (1 << module);
    if (m_filter & local_module) {
        if (g_eventQueue_ptr == NULL ||
            g_eventQueue_ptr->getTime() >= m_starting_cycle) {
            switch (m_verbosityLevel) {
              case No_Verb:
                return false;
              case Low_Verb:
                return (priority == HighPrio);
              case Med_Verb:
                return (priority == HighPrio || priority == MedPrio);
              case High_Verb:
                return true;
            }
        }
    }
    return false;
}

void
Debug::setDebugTime(Time t)
{
    m_starting_cycle = t;
}

void
Debug::setVerbosity(VerbosityLevel vb)
{
    m_verbosityLevel = vb;
}

void
Debug::setFilter(int filter)
{
    m_filter = filter;
}

bool
Debug::setVerbosityString(const char *verb_str)
{
    string verb = verb_str ? verb_str : "";
    if (verb == "none") {
        setVerbosity(No_Verb);
    } else if (verb == "low") {
        setVerbosity(Low_Verb);
    } else if (verb == "med") {
        setVerbosity(Med_Verb);
    } else if (verb == "high") {
        setVerbosity(High_Verb);
    } else {
        cerr << "Error: unrecognized verbosity (use none, low, med, high): "
             << verb << endl;
        return true; // error
    }
    return false; // no error
}

bool
Debug::checkFilter(char ch)
{
    for (int i = 0; i < NUMBER_OF_COMPS; i++) {
        // Look at all components to find a character match
        if (debugComponents[i].ch == ch) {
            // We found a match - return no error
            return false; // no error
        }
    }
    return true; // error
}

bool
Debug::checkFilterString(const char *filter_str)
{
    if (filter_str == NULL) {
        cerr << "Error: unrecognized component filter: NULL" << endl;
        return true; // error
    }

    // check for default filter ("none") before reporting RUBY_DEBUG error
    if (string(filter_str) == "none") {
        return false; // no error
    }

    if (RUBY_DEBUG == false) {
        cerr << "Error: User specified set of debug components, but the "
             << "RUBY_DEBUG compile-time flag is false." << endl
             << "Solution: Re-compile with RUBY_DEBUG set to true." << endl;
        return true; // error
    }

    if (string(filter_str) == "all") {
        return false; // no error
    }

    // scan string checking each character
    for (unsigned int i = 0; i < strlen(filter_str); i++) {
        bool unrecognized = checkFilter(filter_str[i]);
        if (unrecognized == true) {
            return true; // error
        }
    }
    return false; // no error
}

bool
Debug::setFilterString(const char *filter_str)
{
    if (checkFilterString(filter_str)) {
        return true; // error
    }

    if (string(filter_str) == "all" ) {
        allFilter();
    } else if (string(filter_str) == "none") {
        clearFilter();
    } else {
        // scan string adding to bit mask for each component which is present
        for (unsigned int i = 0; i < strlen(filter_str); i++) {
            bool error = addFilter( filter_str[i] );
            if (error) {
                return true; // error
            }
        }
    }
    return false; // no error
}

bool
Debug::addFilter(char ch)
{
    for (int i = 0; i < NUMBER_OF_COMPS; i++) {
        // Look at all components to find a character match
        if (debugComponents[i].ch == ch) {
            // We found a match - update the filter bit mask
            cout << "  Debug: Adding to filter: '" << ch << "' ("
                 << debugComponents[i].desc << ")" << endl;
            m_filter |= (1 << i);
            return false; // no error
        }
    }

    // We didn't find the character
    cerr << "Error: unrecognized component filter: " << ch << endl;
    usageInstructions();
    return true; // error
}

void
Debug::clearFilter()
{
    m_filter = 0;
}

void Debug::allFilter()
{
    m_filter = ~0;
}

void
Debug::usageInstructions(void)
{
    cerr << "Debug components: " << endl;
    for (int i = 0; i < NUMBER_OF_COMPS; i++) {
        cerr << "  " << debugComponents[i].ch << ": "
             << debugComponents[i].desc << endl;
    }
}

void
Debug::print(ostream& out) const
{
    out << "[Debug]" << endl;
}

void
Debug::setDebugOutputFile (const char *filename)
{
    if (filename == NULL || !strcmp(filename, "none")) {
        debug_cout_ptr = &cout;
        return;
    }

    if (m_fout.is_open()) {
        m_fout.close();
    }
    m_fout.open(filename, ios::out);
    if (!m_fout.is_open()) {
        cerr << "setDebugOutputFile: can't open file " << filename << endl;
    } else {
        debug_cout_ptr = &m_fout;
    }
}

void
Debug::closeDebugOutputFile ()
{
    if (m_fout.is_open()) {
        m_fout.close ();
        debug_cout_ptr = &cout;
    }
}

void
Debug::debugMsg( const char *fmt, ...)
{
    va_list  args;

    // you could check validDebug() here before printing the message
    va_start(args, fmt);
    vfprintf(stdout, fmt, args);
    va_end(args);
}

Debug *
RubyDebugParams::create()
{
    return new Debug(this);
}