gem5  v21.1.0.2
ticked_object.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2014, 2017 ARM Limited
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions are
16  * met: redistributions of source code must retain the above copyright
17  * notice, this list of conditions and the following disclaimer;
18  * redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution;
21  * neither the name of the copyright holders nor the names of its
22  * contributors may be used to endorse or promote products derived from
23  * this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
46 #ifndef __SIM_TICKED_OBJECT_HH__
47 #define __SIM_TICKED_OBJECT_HH__
48 
49 #include "sim/clocked_object.hh"
50 
51 namespace gem5
52 {
53 
54 struct TickedObjectParams;
55 
61 class Ticked : public Serializable
62 {
63  protected:
66 
69 
71  void processClockEvent();
72 
74  bool running;
75 
78 
79  private:
82 
83  protected:
86 
89 
92 
93  public:
94  Ticked(ClockedObject &object_,
95  statistics::Scalar *imported_num_cycles = NULL,
97 
98  virtual ~Ticked() { }
99 
102  void regStats();
103 
105  void
107  {
108  if (!running) {
109  if (!event.scheduled())
110  object.schedule(event, object.clockEdge(Cycles(1)));
111  running = true;
114  }
115  }
116 
118  Cycles
120  {
121  return object.curCycle() - lastStopped;
122  }
123 
125  void
127  {
128  lastStopped = object.curCycle();
129  }
130 
132  void
134  {
135  if (running) {
136  if (event.scheduled())
137  object.deschedule(event);
138  running = false;
140  }
141  }
142 
144  void serialize(CheckpointOut &cp) const override;
145  void unserialize(CheckpointIn &cp) override;
146 
148  virtual void evaluate() = 0;
149 
161  virtual void countCycles(Cycles delta) {}
162 };
163 
166 class TickedObject : public ClockedObject, public Ticked
167 {
168  public:
169  TickedObject(const TickedObjectParams &params,
171 
176 
178  void regStats() override;
179  void serialize(CheckpointOut &cp) const override;
180  void unserialize(CheckpointIn &cp) override;
181 };
182 
183 } // namespace gem5
184 
185 #endif /* __SIM_TICKED_OBJECT_HH__ */
gem5::statistics::Scalar
This is a simple scalar statistic, like a counter.
Definition: statistics.hh:1927
gem5::Ticked::serialize
void serialize(CheckpointOut &cp) const override
Checkpoint lastStopped.
Definition: ticked_object.cc:90
gem5::Ticked::numCycles
statistics::Scalar & numCycles
Total number of cycles either ticked or spend stopped.
Definition: ticked_object.hh:85
gem5::Ticked::start
void start()
Start ticking.
Definition: ticked_object.hh:106
gem5::Ticked::cyclesSinceLastStopped
Cycles cyclesSinceLastStopped() const
How long have we been stopped for?
Definition: ticked_object.hh:119
gem5::CheckpointIn
Definition: serialize.hh:68
gem5::Ticked::event
EventFunctionWrapper event
The wrapper for processClockEvent.
Definition: ticked_object.hh:68
gem5::Ticked
Ticked attaches gem5's event queue/scheduler to evaluate calls and provides a start/stop interface to...
Definition: ticked_object.hh:61
gem5::Ticked::regStats
void regStats()
Register {num,ticks}Cycles if necessary.
Definition: ticked_object.cc:71
gem5::Ticked::tickCycles
statistics::Scalar tickCycles
Number of cycles ticked.
Definition: ticked_object.hh:88
gem5::statistics::Formula
A formula for statistics that is calculated when printed.
Definition: statistics.hh:2536
gem5::ClockedObject::unserialize
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: clocked_object.cc:64
gem5::TickedObject::unserialize
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: ticked_object.cc:134
gem5::Cycles
Cycles is a wrapper class for representing cycle counts, i.e.
Definition: types.hh:78
gem5::Serializable
Basic support for object serialization.
Definition: serialize.hh:169
gem5::Ticked::Ticked
Ticked(ClockedObject &object_, statistics::Scalar *imported_num_cycles=NULL, Event::Priority priority=Event::CPU_Tick_Pri)
Definition: ticked_object.cc:47
gem5::SimObject::params
const Params & params() const
Definition: sim_object.hh:176
gem5::Ticked::running
bool running
Have I been started? and am not stopped.
Definition: ticked_object.hh:74
gem5::Ticked::processClockEvent
void processClockEvent()
Evaluate and reschedule.
Definition: ticked_object.cc:61
gem5::Ticked::unserialize
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: ticked_object.cc:98
gem5::ClockedObject::serialize
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: clocked_object.cc:59
gem5::TickedObject
TickedObject attaches Ticked to ClockedObject and can be used as a base class where ticked operation.
Definition: ticked_object.hh:166
gem5::Ticked::numCyclesLocal
statistics::Scalar * numCyclesLocal
Locally allocated stats.
Definition: ticked_object.hh:81
gem5::Ticked::object
ClockedObject & object
ClockedObject who is responsible for this Ticked's actions/stats.
Definition: ticked_object.hh:65
gem5::TickedObject::serialize
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: ticked_object.cc:128
gem5::statistics::Group::regStats
virtual void regStats()
Callback to set stat parameters.
Definition: group.cc:69
gem5::TickedObject::TickedObject
TickedObject(const TickedObjectParams &params, Event::Priority priority=Event::CPU_Tick_Pri)
Definition: ticked_object.cc:113
gem5::ClockedObject
The ClockedObject class extends the SimObject with a clock and accessor functions to relate ticks to ...
Definition: clocked_object.hh:234
gem5::EventFunctionWrapper
Definition: eventq.hh:1115
gem5::Ticked::evaluate
virtual void evaluate()=0
Action to call on the clock tick.
gem5::Ticked::resetLastStopped
void resetLastStopped()
Reset stopped time to current time.
Definition: ticked_object.hh:126
gem5::Ticked::idleCycles
statistics::Formula idleCycles
Number of cycles stopped.
Definition: ticked_object.hh:91
clocked_object.hh
gem5::EventBase::Priority
int8_t Priority
Definition: eventq.hh:123
gem5::CheckpointOut
std::ostream CheckpointOut
Definition: serialize.hh:66
gem5::Ticked::~Ticked
virtual ~Ticked()
Definition: ticked_object.hh:98
gem5::Ticked::stop
void stop()
Cancel the next tick event and issue no more.
Definition: ticked_object.hh:133
gem5::Ticked::countCycles
virtual void countCycles(Cycles delta)
Callback to handle cycle statistics and probes.
Definition: ticked_object.hh:161
gem5::EventBase::CPU_Tick_Pri
static const Priority CPU_Tick_Pri
CPU ticks must come after other associated CPU events (such as writebacks).
Definition: eventq.hh:204
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::TickedObject::regStats
void regStats() override
Pass on regStats, serialize etc.
Definition: ticked_object.cc:121
gem5::Ticked::lastStopped
Cycles lastStopped
Time of last stop event to calculate run time.
Definition: ticked_object.hh:77
gem5::Event::scheduled
bool scheduled() const
Determine if the current event is scheduled.
Definition: eventq.hh:465

Generated on Tue Sep 21 2021 12:25:48 for gem5 by doxygen 1.8.17