debug.hh revision 10685:a24286e33318 
1/*
2 * Copyright (c) 2003-2005 The Regents of The University of Michigan
3 * Copyright (c) 2010 The Hewlett-Packard Development Company
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * Authors: Nathan Binkert
30 */
31
32#ifndef __BASE_DEBUG_HH__
33#define __BASE_DEBUG_HH__
34
35#include <map>
36#include <string>
37#include <vector>
38
39namespace Debug {
40
41void breakpoint();
42
43class Flag
44{
45  protected:
46    const char *_name;
47    const char *_desc;
48    std::vector<Flag *> _kids;
49
50  public:
51    Flag(const char *name, const char *desc);
52    virtual ~Flag();
53
54    std::string name() const { return _name; }
55    std::string desc() const { return _desc; }
56    std::vector<Flag *> kids() { return _kids; }
57
58    virtual void enable() = 0;
59    virtual void disable() = 0;
60};
61
62class SimpleFlag : public Flag
63{
64  protected:
65    bool _status;
66
67  public:
68    SimpleFlag(const char *name, const char *desc)
69        : Flag(name, desc), _status(false)
70    { }
71
72    bool status() const { return _status; }
73    operator bool() const { return _status; }
74    bool operator!() const { return !_status; }
75
76    void enable() { _status = true; }
77    void disable() { _status = false; }
78};
79
80class CompoundFlag : public SimpleFlag
81{
82  protected:
83    void
84    addFlag(Flag *f)
85    {
86        if (f != nullptr)
87            _kids.push_back(f);
88    }
89
90  public:
91    CompoundFlag(const char *name, const char *desc,
92        Flag *f00 = nullptr, Flag *f01 = nullptr,
93        Flag *f02 = nullptr, Flag *f03 = nullptr,
94        Flag *f04 = nullptr, Flag *f05 = nullptr,
95        Flag *f06 = nullptr, Flag *f07 = nullptr,
96        Flag *f08 = nullptr, Flag *f09 = nullptr,
97        Flag *f10 = nullptr, Flag *f11 = nullptr,
98        Flag *f12 = nullptr, Flag *f13 = nullptr,
99        Flag *f14 = nullptr, Flag *f15 = nullptr,
100        Flag *f16 = nullptr, Flag *f17 = nullptr,
101        Flag *f18 = nullptr, Flag *f19 = nullptr)
102        : SimpleFlag(name, desc)
103    {
104        addFlag(f00); addFlag(f01); addFlag(f02); addFlag(f03); addFlag(f04);
105        addFlag(f05); addFlag(f06); addFlag(f07); addFlag(f08); addFlag(f09);
106        addFlag(f10); addFlag(f11); addFlag(f12); addFlag(f13); addFlag(f14);
107        addFlag(f15); addFlag(f16); addFlag(f17); addFlag(f18); addFlag(f19);
108    }
109
110    void enable();
111    void disable();
112};
113
114typedef std::map<std::string, Flag *> FlagsMap;
115FlagsMap &allFlags();
116
117Flag *findFlag(const std::string &name);
118
119extern Flag *const All;
120
121bool changeFlag(const char *s, bool value);
122
123} // namespace Debug
124
125void setDebugFlag(const char *string);
126
127void clearDebugFlag(const char *string);
128
129void dumpDebugFlags();
130
131#endif // __BASE_DEBUG_HH__
132