debug.cc revision 11153:20bbfe5b2b86 
1/*
2 * Copyright (c) 2003-2005 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 */
30
31#include <sys/types.h>
32#include <unistd.h>
33
34#include <algorithm>
35#include <csignal>
36
37#include "base/cprintf.hh"
38#include "base/debug.hh"
39#include "base/misc.hh"
40
41using namespace std;
42
43namespace Debug {
44
45//
46// This function will cause the process to signal itself with a
47// SIGTRAP which is ignored if not in gdb, but will cause the debugger
48// to break if in gdb.
49//
50void
51breakpoint()
52{
53#ifndef NDEBUG
54    kill(getpid(), SIGTRAP);
55#else
56    cprintf("Debug::breakpoint suppressed, compiled with NDEBUG\n");
57#endif
58}
59
60//
61// Flags for debugging purposes.  Primarily for trace.hh
62//
63int allFlagsVersion = 0;
64FlagsMap &
65allFlags()
66{
67    static FlagsMap flags;
68    return flags;
69}
70
71bool SimpleFlag::_active = false;
72
73Flag *
74findFlag(const std::string &name)
75{
76    FlagsMap::iterator i = allFlags().find(name);
77    if (i == allFlags().end())
78        return NULL;
79    return i->second;
80}
81
82Flag::Flag(const char *name, const char *desc)
83    : _name(name), _desc(desc)
84{
85    pair<FlagsMap::iterator, bool> result =
86        allFlags().insert(make_pair(name, this));
87
88    if (!result.second)
89        panic("Flag %s already defined!", name);
90
91    ++allFlagsVersion;
92}
93
94Flag::~Flag()
95{
96    // should find and remove flag.
97}
98
99void
100SimpleFlag::enableAll()
101{
102    _active = true;
103    for (auto& i : allFlags())
104        i.second->sync();
105}
106
107void
108SimpleFlag::disableAll()
109{
110    _active = false;
111    for (auto& i : allFlags())
112        i.second->sync();
113}
114
115void
116CompoundFlag::enable()
117{
118    for (auto& k : _kids)
119        k->enable();
120}
121
122void
123CompoundFlag::disable()
124{
125    for (auto& k : _kids)
126        k->disable();
127}
128
129struct AllFlags : public Flag
130{
131    AllFlags()
132        : Flag("All", "All Flags")
133    {}
134
135    void
136    enable()
137    {
138        FlagsMap::iterator i = allFlags().begin();
139        FlagsMap::iterator end = allFlags().end();
140        for (; i != end; ++i)
141            if (i->second != this)
142                i->second->enable();
143    }
144
145    void
146    disable()
147    {
148        FlagsMap::iterator i = allFlags().begin();
149        FlagsMap::iterator end = allFlags().end();
150        for (; i != end; ++i)
151            if (i->second != this)
152                i->second->disable();
153    }
154};
155
156AllFlags theAllFlags;
157Flag *const All = &theAllFlags;
158
159bool
160changeFlag(const char *s, bool value)
161{
162    Flag *f = findFlag(s);
163    if (!f)
164        return false;
165
166    if (value)
167        f->enable();
168    else
169        f->disable();
170
171    return true;
172}
173
174} // namespace Debug
175
176// add a set of functions that can easily be invoked from gdb
177void
178setDebugFlag(const char *string)
179{
180    Debug::changeFlag(string, true);
181}
182
183void
184clearDebugFlag(const char *string)
185{
186    Debug::changeFlag(string, false);
187}
188
189void
190dumpDebugFlags()
191{
192    using namespace Debug;
193    FlagsMap::iterator i = allFlags().begin();
194    FlagsMap::iterator end = allFlags().end();
195    for (; i != end; ++i) {
196        SimpleFlag *f = dynamic_cast<SimpleFlag *>(i->second);
197        if (f && f->status())
198            cprintf("%s\n", f->name());
199    }
200}
201