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