derek/gem5
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

base: Cleanup debug flags API

Browse Source 
The debug flags API has a couple of quirks that should be cleaned
up. Specifically:

 * Only CompoundFlag should expose a list of children.
 * The global enable flag is just called "active", this isn't very
   descriptive.
 * Only SimpleFlag exposed a status member. This should be in the base
   class to make the API symmetric.
 * Flag::Sync() is an implementation detail and needs to be protected.

Change-Id: I4d7fd32c80891191aa04f0bd0c334c8cf8d372f5
Signed-off-by: Andreas Sandberg <andreas.sandberg@arm.com>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/34118
Reviewed-by: Jason Lowe-Power <power.jg@gmail.com>
Maintainer: Jason Lowe-Power <power.jg@gmail.com>
Tested-by: kokoro <noreply+kokoro@google.com>
This commit is contained in:
Andreas Sandberg
2020-09-04 16:01:24 +01:00
parent 15a37b7dc5
commit 93ccc23b4a
5 changed files with 79 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
src/base/debug.hh
View File

@@ -1,4 +1,16 @@
/*
* Copyright (c) 2020 ARM Limited
* All rights reserved
*
* The license below extends only to copyright in the software and shall
* not be construed as granting a license to any other intellectual
* property including but not limited to intellectual property relating
* to a hardware implementation of the functionality of the software
* licensed hereunder. You may use the software subject to the license
* terms below provided that you ensure that this notice is replicated
* unmodified and in its entirety in all distributions of the software,
* modified or unmodified, in source code or in binary form.
*
* Copyright (c) 2003-2005 The Regents of The University of Michigan
* Copyright (c) 2010 The Hewlett-Packard Development Company
* All rights reserved.
@@ -42,45 +54,48 @@ void breakpoint();
class Flag
{
protected:
static bool _globalEnable; // whether debug tracings are enabled
const char *_name;
const char *_desc;
virtual void sync() { }
public:
Flag(const char *name, const char *desc);
virtual ~Flag();
std::string name() const { return _name; }
std::string desc() const { return _desc; }
virtual std::vector<Flag *> kids() { return std::vector<Flag*>(); }
virtual void enable() = 0;
virtual void disable() = 0;
virtual void sync() {}
virtual bool status() const = 0;
operator bool() const { return status(); }
bool operator!() const { return !status(); }
static void globalEnable();
static void globalDisable();
};
class SimpleFlag : public Flag
{
static bool _active; // whether debug tracings are enabled
protected:
bool _tracing; // tracing is enabled and flag is on
bool _status; // flag status
void sync() override { _tracing = _globalEnable && _status; }
public:
SimpleFlag(const char *name, const char *desc)
: Flag(name, desc), _status(false)
{ }
bool status() const { return _tracing; }
operator bool() const { return _tracing; }
bool operator!() const { return !_tracing; }
bool status() const override { return _tracing; }
void enable() { _status = true; sync(); }
void disable() { _status = false; sync(); }
void sync() { _tracing = _active && _status; }
static void enableAll();
static void disableAll();
void enable() override { _status = true; sync(); }
void disable() override { _status = false; sync(); }
};
class CompoundFlag : public Flag
@@ -97,10 +112,11 @@ class CompoundFlag : public Flag
{
}
std::vector<Flag *> kids() { return _kids; }
const std::vector<Flag *> &kids() const { return _kids; }
void enable();
void disable();
void enable() override;
void disable() override;
bool status() const override;
};
typedef std::map<std::string, Flag *> FlagsMap;