sim: Split ClockedObject to make it usable to non-SimObjects

Split ClockedObject into two classes: Clocked that provides the basic
clock functionality, and ClockedObject that inherits from Clocked and
SimObject to provide the functionality of the old ClockedObject.
This commit is contained in:
Andreas Sandberg 2015-08-07 09:59:22 +01:00
parent 9b2426ecfc
commit f7ff27afe8
2 changed files with 27 additions and 19 deletions

View file

@ -62,7 +62,7 @@
*/ */
class DerivedClockDomain; class DerivedClockDomain;
class VoltageDomain; class VoltageDomain;
class ClockedObject; class Clocked;
/** /**
* The ClockDomain provides clock to group of clocked objects bundled * The ClockDomain provides clock to group of clocked objects bundled
@ -103,7 +103,7 @@ class ClockDomain : public SimObject
* Pointers to members of this clock domain, so that when the clock * Pointers to members of this clock domain, so that when the clock
* period changes, we can update each member's tick. * period changes, we can update each member's tick.
*/ */
std::vector<ClockedObject*> members; std::vector<Clocked *> members;
public: public:
@ -123,11 +123,11 @@ class ClockDomain : public SimObject
Tick clockPeriod() const { return _clockPeriod; } Tick clockPeriod() const { return _clockPeriod; }
/** /**
* Register a ClockedObject to this ClockDomain. * Register a Clocked object with this ClockDomain.
* *
* @param ClockedObject to add as a member * @param Clocked to add as a member
*/ */
void registerWithClockDomain(ClockedObject *c) void registerWithClockDomain(Clocked *c)
{ {
assert(c != NULL); assert(c != NULL);
assert(std::find(members.begin(), members.end(), c) == members.end()); assert(std::find(members.begin(), members.end(), c) == members.end());

View file

@ -55,14 +55,14 @@
#include "sim/sim_object.hh" #include "sim/sim_object.hh"
/** /**
* The ClockedObject class extends the SimObject with a clock and * Helper class for objects that need to be clocked. Clocked objects
* accessor functions to relate ticks to the cycles of the object. * typically inherit from this class. Objects that need SimObject
* functionality as well should inherit from ClockedObject.
*/ */
class ClockedObject : public SimObject class Clocked
{ {
private: private:
// the tick value of the next clock edge (>= curTick()) at the // the tick value of the next clock edge (>= curTick()) at the
// time of the last call to update() // time of the last call to update()
mutable Tick tick; mutable Tick tick;
@ -71,13 +71,6 @@ class ClockedObject : public SimObject
// 'tick' // 'tick'
mutable Cycles cycle; mutable Cycles cycle;
/**
* Prevent inadvertent use of the copy constructor and assignment
* operator by making them private.
*/
ClockedObject(ClockedObject&);
ClockedObject& operator=(ClockedObject&);
/** /**
* Align cycle and tick to the next clock edge if not already done. When * Align cycle and tick to the next clock edge if not already done. When
* complete, tick must be at least curTick(). * complete, tick must be at least curTick().
@ -118,18 +111,21 @@ class ClockedObject : public SimObject
* Create a clocked object and set the clock domain based on the * Create a clocked object and set the clock domain based on the
* parameters. * parameters.
*/ */
ClockedObject(const ClockedObjectParams* p) : Clocked(ClockDomain &clk_domain)
SimObject(p), tick(0), cycle(0), clockDomain(*p->clk_domain) : tick(0), cycle(0), clockDomain(clk_domain)
{ {
// Register with the clock domain, so that if the clock domain // Register with the clock domain, so that if the clock domain
// frequency changes, we can update this object's tick. // frequency changes, we can update this object's tick.
clockDomain.registerWithClockDomain(this); clockDomain.registerWithClockDomain(this);
} }
Clocked(Clocked &) = delete;
Clocked &operator=(Clocked &) = delete;
/** /**
* Virtual destructor due to inheritance. * Virtual destructor due to inheritance.
*/ */
virtual ~ClockedObject() { } virtual ~Clocked() { }
/** /**
* Reset the object's clock using the current global tick value. Likely * Reset the object's clock using the current global tick value. Likely
@ -221,4 +217,16 @@ class ClockedObject : public SimObject
}; };
/**
* The ClockedObject class extends the SimObject with a clock and
* accessor functions to relate ticks to the cycles of the object.
*/
class ClockedObject
: public SimObject, public Clocked
{
public:
ClockedObject(const ClockedObjectParams *p)
: SimObject(p), Clocked(*p->clk_domain) { }
};
#endif //__SIM_CLOCKED_OBJECT_HH__ #endif //__SIM_CLOCKED_OBJECT_HH__