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
49  public:
50    Flag(const char *name, const char *desc);
51    virtual ~Flag();
52
53    std::string name() const { return _name; }
54    std::string desc() const { return _desc; }
55    virtual std::vector<Flag *> kids() { return std::vector<Flag*>(); }
56
57    virtual void enable() = 0;
58    virtual void disable() = 0;
59    virtual void sync() {}
60};
61
62class SimpleFlag : public Flag
63{
64    static bool _active; // whether debug tracings are enabled
65  protected:
66    bool _tracing; // tracing is enabled and flag is on
67    bool _status;  // flag status
68
69  public:
70    SimpleFlag(const char *name, const char *desc)
71        : Flag(name, desc), _status(false)
72    { }
73
74    bool status() const { return _tracing; }
75    operator bool() const { return _tracing; }
76    bool operator!() const { return !_tracing; }
77
78    void enable()  { _status = true;  sync(); }
79    void disable() { _status = false; sync(); }
80
81    void sync() { _tracing = _active && _status; }
82
83    static void enableAll();
84    static void disableAll();
85};
86
87class CompoundFlag : public Flag
88{
89  protected:
90    std::vector<Flag *> _kids;
91
92    void
93    addFlag(Flag *f)
94    {
95        if (f != nullptr)
96            _kids.push_back(f);
97    }
98
99  public:
100    CompoundFlag(const char *name, const char *desc,
101        Flag *f00 = nullptr, Flag *f01 = nullptr,
102        Flag *f02 = nullptr, Flag *f03 = nullptr,
103        Flag *f04 = nullptr, Flag *f05 = nullptr,
104        Flag *f06 = nullptr, Flag *f07 = nullptr,
105        Flag *f08 = nullptr, Flag *f09 = nullptr,
106        Flag *f10 = nullptr, Flag *f11 = nullptr,
107        Flag *f12 = nullptr, Flag *f13 = nullptr,
108        Flag *f14 = nullptr, Flag *f15 = nullptr,
109        Flag *f16 = nullptr, Flag *f17 = nullptr,
110        Flag *f18 = nullptr, Flag *f19 = nullptr)
111        : Flag(name, desc)
112    {
113        addFlag(f00); addFlag(f01); addFlag(f02); addFlag(f03); addFlag(f04);
114        addFlag(f05); addFlag(f06); addFlag(f07); addFlag(f08); addFlag(f09);
115        addFlag(f10); addFlag(f11); addFlag(f12); addFlag(f13); addFlag(f14);
116        addFlag(f15); addFlag(f16); addFlag(f17); addFlag(f18); addFlag(f19);
117    }
118
119    std::vector<Flag *> kids() { return _kids; }
120
121    void enable();
122    void disable();
123};
124
125typedef std::map<std::string, Flag *> FlagsMap;
126FlagsMap &allFlags();
127
128Flag *findFlag(const std::string &name);
129
130extern Flag *const All;
131
132bool changeFlag(const char *s, bool value);
133
134} // namespace Debug
135
136void setDebugFlag(const char *string);
137
138void clearDebugFlag(const char *string);
139
140void dumpDebugFlags();
141
142#endif // __BASE_DEBUG_HH__
143