debug.cc revision 9554:406fbcf60223 
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
71Flag *
72findFlag(const std::string &name)
73{
74    FlagsMap::iterator i = allFlags().find(name);
75    if (i == allFlags().end())
76        return NULL;
77    return i->second;
78}
79
80Flag::Flag(const char *name, const char *desc)
81    : _name(name), _desc(desc)
82{
83    pair<FlagsMap::iterator, bool> result =
84        allFlags().insert(make_pair(name, this));
85
86    if (!result.second)
87        panic("Flag %s already defined!", name);
88
89    ++allFlagsVersion;
90}
91
92Flag::~Flag()
93{
94    // should find and remove flag.
95}
96
97void
98CompoundFlag::enable()
99{
100    SimpleFlag::enable();
101    for_each(_kids.begin(), _kids.end(), mem_fun(&Flag::enable));
102}
103
104void
105CompoundFlag::disable()
106{
107    SimpleFlag::disable();
108    for_each(_kids.begin(), _kids.end(), mem_fun(&Flag::disable));
109}
110
111struct AllFlags : public Flag
112{
113    AllFlags()
114        : Flag("All", "All Flags")
115    {}
116
117    void
118    enable()
119    {
120        FlagsMap::iterator i = allFlags().begin();
121        FlagsMap::iterator end = allFlags().end();
122        for (; i != end; ++i)
123            if (i->second != this)
124                i->second->enable();
125    }
126
127    void
128    disable()
129    {
130        FlagsMap::iterator i = allFlags().begin();
131        FlagsMap::iterator end = allFlags().end();
132        for (; i != end; ++i)
133            if (i->second != this)
134                i->second->disable();
135    }
136};
137
138AllFlags theAllFlags;
139Flag *const All = &theAllFlags;
140
141bool
142changeFlag(const char *s, bool value)
143{
144    Flag *f = findFlag(s);
145    if (!f)
146        return false;
147
148    if (value)
149        f->enable();
150    else
151        f->disable();
152
153    return true;
154}
155
156} // namespace Debug
157
158// add a set of functions that can easily be invoked from gdb
159void
160setDebugFlag(const char *string)
161{
162    Debug::changeFlag(string, true);
163}
164
165void
166clearDebugFlag(const char *string)
167{
168    Debug::changeFlag(string, false);
169}
170
171void
172dumpDebugFlags()
173{
174    using namespace Debug;
175    FlagsMap::iterator i = allFlags().begin();
176    FlagsMap::iterator end = allFlags().end();
177    for (; i != end; ++i) {
178        SimpleFlag *f = dynamic_cast<SimpleFlag *>(i->second);
179        if (f && f->status())
180            cprintf("%s\n", f->name());
181    }
182}
183