gem5  v21.1.0.2
ticked_object.cc
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 
38 #include "sim/ticked_object.hh"
39 
40 #include "params/TickedObject.hh"
41 #include "sim/clocked_object.hh"
42 #include "sim/serialize.hh"
43 
44 namespace gem5
45 {
46 
48  statistics::Scalar *imported_num_cycles,
49  Event::Priority priority) :
50  object(object_),
51  event([this]{ processClockEvent(); }, object_.name(), false, priority),
52  running(false),
53  lastStopped(0),
54  /* Allocate numCycles if an external stat wasn't passed in */
55  numCyclesLocal((imported_num_cycles ? NULL : new statistics::Scalar)),
56  numCycles((imported_num_cycles ? *imported_num_cycles :
57  *numCyclesLocal))
58 { }
59 
60 void
62  ++tickCycles;
63  ++numCycles;
64  countCycles(Cycles(1));
65  evaluate();
66  if (running)
67  object.schedule(event, object.clockEdge(Cycles(1)));
68 }
69 
70 void
72 {
73  if (numCyclesLocal) {
74  numCycles
75  .name(object.name() + ".totalTickCycles")
76  .desc("Number of cycles that the object ticked or was stopped");
77  }
78 
80  .name(object.name() + ".tickCycles")
81  .desc("Number of cycles that the object actually ticked");
82 
84  .name(object.name() + ".idleCycles")
85  .desc("Total number of cycles that the object has spent stopped");
87 }
88 
89 void
91 {
92  uint64_t lastStoppedUint = lastStopped;
93 
94  paramOut(cp, "lastStopped", lastStoppedUint);
95 }
96 
97 void
99 {
100  uint64_t lastStoppedUint = 0;
101 
102  /* lastStopped is optional on checkpoint restore as this object may be
103  * being restored from one which has a common base (and so possibly
104  * many common checkpointed values) but where Ticked is used in the
105  * checkpointed object but not this one.
106  * An example would be a CPU model using Ticked restores from a
107  * simple CPU without without Ticked */
108  optParamIn(cp, "lastStopped", lastStoppedUint);
109 
110  lastStopped = Cycles(lastStoppedUint);
111 }
112 
113 TickedObject::TickedObject(const TickedObjectParams &params,
114  Event::Priority priority) :
115  ClockedObject(params),
116  /* Make numCycles in Ticked */
117  Ticked(*this, NULL, priority)
118 { }
119 
120 void
122 {
125 }
126 
127 void
129 {
130  Ticked::serialize(cp);
132 }
133 void
135 {
138 }
139 
140 } // namespace gem5
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
serialize.hh
gem5::CheckpointIn
Definition: serialize.hh:68
gem5::Ticked::event
EventFunctionWrapper event
The wrapper for processClockEvent.
Definition: ticked_object.hh:68
gem5::MipsISA::event
Bitfield< 10, 5 > event
Definition: pra_constants.hh:300
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::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::Ticked::Ticked
Ticked(ClockedObject &object_, statistics::Scalar *imported_num_cycles=NULL, Event::Priority priority=Event::CPU_Tick_Pri)
Definition: ticked_object.cc:47
gem5::statistics::DataWrap::name
Derived & name(const std::string &name)
Set the name and marks this stat to print at the end of simulation.
Definition: statistics.hh:286
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::Ticked::numCyclesLocal
statistics::Scalar * numCyclesLocal
Locally allocated stats.
Definition: ticked_object.hh:81
gem5::TickedObject::serialize
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: ticked_object.cc:128
name
const std::string & name()
Definition: trace.cc:49
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
ticked_object.hh
gem5::Ticked::evaluate
virtual void evaluate()=0
Action to call on the clock tick.
gem5::optParamIn
bool optParamIn(CheckpointIn &cp, const std::string &name, T &param, bool do_warn=true)
This function is used for restoring optional parameters from the checkpoint.
Definition: serialize.hh:357
gem5::statistics::DataWrap::desc
Derived & desc(const std::string &_desc)
Set the description and marks this stat to print at the end of simulation.
Definition: statistics.hh:331
gem5::paramOut
void paramOut(CheckpointOut &cp, const std::string &name, ExtMachInst const &machInst)
Definition: types.cc:40
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::countCycles
virtual void countCycles(Cycles delta)
Callback to handle cycle statistics and probes.
Definition: ticked_object.hh:161
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

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