1/*
| 1/*
|
2 * Copyright (c) 2012-2013 ARM Limited
| 2 * Copyright (c) 2012-2013, 2015-2016 ARM Limited
|
3 * Copyright (c) 2013 Cornell University 4 * All rights reserved 5 * 6 * The license below extends only to copyright in the software and shall 7 * not be construed as granting a license to any other intellectual 8 * property including but not limited to intellectual property relating 9 * to a hardware implementation of the functionality of the software 10 * licensed hereunder. You may use the software subject to the license 11 * terms below provided that you ensure that this notice is replicated 12 * unmodified and in its entirety in all distributions of the software, 13 * modified or unmodified, in source code or in binary form. 14 * 15 * Redistribution and use in source and binary forms, with or without 16 * modification, are permitted provided that the following conditions are 17 * met: redistributions of source code must retain the above copyright 18 * notice, this list of conditions and the following disclaimer; 19 * redistributions in binary form must reproduce the above copyright 20 * notice, this list of conditions and the following disclaimer in the 21 * documentation and/or other materials provided with the distribution; 22 * neither the name of the copyright holders nor the names of its 23 * contributors may be used to endorse or promote products derived from 24 * this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 27 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 28 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 29 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 30 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 31 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 32 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 33 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 34 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 35 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 36 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 37 * 38 * Authors: Andreas Hansson 39 * Christopher Torng
| 3 * Copyright (c) 2013 Cornell University 4 * All rights reserved 5 * 6 * The license below extends only to copyright in the software and shall 7 * not be construed as granting a license to any other intellectual 8 * property including but not limited to intellectual property relating 9 * to a hardware implementation of the functionality of the software 10 * licensed hereunder. You may use the software subject to the license 11 * terms below provided that you ensure that this notice is replicated 12 * unmodified and in its entirety in all distributions of the software, 13 * modified or unmodified, in source code or in binary form. 14 * 15 * Redistribution and use in source and binary forms, with or without 16 * modification, are permitted provided that the following conditions are 17 * met: redistributions of source code must retain the above copyright 18 * notice, this list of conditions and the following disclaimer; 19 * redistributions in binary form must reproduce the above copyright 20 * notice, this list of conditions and the following disclaimer in the 21 * documentation and/or other materials provided with the distribution; 22 * neither the name of the copyright holders nor the names of its 23 * contributors may be used to endorse or promote products derived from 24 * this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 27 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 28 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 29 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 30 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 31 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 32 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 33 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 34 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 35 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 36 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 37 * 38 * Authors: Andreas Hansson 39 * Christopher Torng
|
| 40 * Akash Bagdia 41 * David Guillen Fandos
|
40 */ 41 42/** 43 * @file 44 * ClockedObject declaration and implementation. 45 */ 46 47#ifndef __SIM_CLOCKED_OBJECT_HH__ 48#define __SIM_CLOCKED_OBJECT_HH__ 49
| 42 */ 43 44/** 45 * @file 46 * ClockedObject declaration and implementation. 47 */ 48 49#ifndef __SIM_CLOCKED_OBJECT_HH__ 50#define __SIM_CLOCKED_OBJECT_HH__ 51
|
| 52#include "base/callback.hh"
|
50#include "base/intmath.hh" 51#include "base/misc.hh"
| 53#include "base/intmath.hh" 54#include "base/misc.hh"
|
| 55#include "enums/PwrState.hh"
|
52#include "params/ClockedObject.hh" 53#include "sim/core.hh" 54#include "sim/clock_domain.hh" 55#include "sim/sim_object.hh" 56 57/** 58 * Helper class for objects that need to be clocked. Clocked objects 59 * typically inherit from this class. Objects that need SimObject 60 * functionality as well should inherit from ClockedObject. 61 */ 62class Clocked 63{ 64 65 private: 66 // the tick value of the next clock edge (>= curTick()) at the 67 // time of the last call to update() 68 mutable Tick tick; 69 70 // The cycle counter value corresponding to the current value of 71 // 'tick' 72 mutable Cycles cycle; 73 74 /** 75 * Align cycle and tick to the next clock edge if not already done. When 76 * complete, tick must be at least curTick(). 77 */ 78 void update() const 79 { 80 // both tick and cycle are up-to-date and we are done, note 81 // that the >= is important as it captures cases where tick 82 // has already passed curTick() 83 if (tick >= curTick()) 84 return; 85 86 // optimise for the common case and see if the tick should be 87 // advanced by a single clock period 88 tick += clockPeriod(); 89 ++cycle; 90 91 // see if we are done at this point 92 if (tick >= curTick()) 93 return; 94 95 // if not, we have to recalculate the cycle and tick, we 96 // perform the calculations in terms of relative cycles to 97 // allow changes to the clock period in the future 98 Cycles elapsedCycles(divCeil(curTick() - tick, clockPeriod())); 99 cycle += elapsedCycles; 100 tick += elapsedCycles * clockPeriod(); 101 } 102 103 /** 104 * The clock domain this clocked object belongs to 105 */ 106 ClockDomain &clockDomain; 107 108 protected: 109 110 /** 111 * Create a clocked object and set the clock domain based on the 112 * parameters. 113 */ 114 Clocked(ClockDomain &clk_domain) 115 : tick(0), cycle(0), clockDomain(clk_domain) 116 { 117 // Register with the clock domain, so that if the clock domain 118 // frequency changes, we can update this object's tick. 119 clockDomain.registerWithClockDomain(this); 120 } 121 122 Clocked(Clocked &) = delete; 123 Clocked &operator=(Clocked &) = delete; 124 125 /** 126 * Virtual destructor due to inheritance. 127 */ 128 virtual ~Clocked() { } 129 130 /** 131 * Reset the object's clock using the current global tick value. Likely 132 * to be used only when the global clock is reset. Currently, this done 133 * only when Ruby is done warming up the memory system. 134 */ 135 void resetClock() const 136 { 137 Cycles elapsedCycles(divCeil(curTick(), clockPeriod())); 138 cycle = elapsedCycles; 139 tick = elapsedCycles * clockPeriod(); 140 } 141 142 public: 143 144 /** 145 * Update the tick to the current tick. 146 * 147 */ 148 inline void updateClockPeriod() const 149 { 150 update(); 151 } 152 153 /** 154 * Determine the tick when a cycle begins, by default the current one, but 155 * the argument also enables the caller to determine a future cycle. When 156 * curTick() is on a clock edge, the number of cycles in the parameter is 157 * added to curTick() to be returned. When curTick() is not aligned to a 158 * clock edge, the number of cycles in the parameter is added to the next 159 * clock edge. 160 * 161 * @param cycles The number of cycles into the future 162 * 163 * @return The start tick when the requested clock edge occurs. Precisely, 164 * this tick can be 165 * curTick() + [0, clockPeriod()) + clockPeriod() * cycles 166 */ 167 inline Tick clockEdge(Cycles cycles = Cycles(0)) const 168 { 169 // align tick to the next clock edge 170 update(); 171 172 // figure out when this future cycle is 173 return tick + clockPeriod() * cycles; 174 } 175 176 /** 177 * Determine the current cycle, corresponding to a tick aligned to 178 * a clock edge. 179 * 180 * @return When curTick() is on a clock edge, return the Cycle corresponding 181 * to that clock edge. When curTick() is not on a clock edge, return the 182 * Cycle corresponding to the next clock edge. 183 */ 184 inline Cycles curCycle() const 185 { 186 // align cycle to the next clock edge. 187 update(); 188 189 return cycle; 190 } 191 192 /** 193 * Based on the clock of the object, determine the start tick of the first 194 * cycle that is at least one cycle in the future. When curTick() is at the 195 * current cycle edge, this returns the next clock edge. When calling this 196 * during the middle of a cycle, this returns 2 clock edges in the future. 197 * 198 * @return The start tick of the first cycle that is at least one cycle in 199 * the future. Precisely, the returned tick can be in the range 200 * curTick() + [clockPeriod(), 2 * clockPeriod()) 201 */ 202 Tick nextCycle() const 203 { return clockEdge(Cycles(1)); } 204 205 inline uint64_t frequency() const 206 { 207 return SimClock::Frequency / clockPeriod(); 208 } 209 210 inline Tick clockPeriod() const 211 { 212 return clockDomain.clockPeriod(); 213 } 214 215 inline double voltage() const 216 { 217 return clockDomain.voltage(); 218 } 219 220 inline Cycles ticksToCycles(Tick t) const 221 { return Cycles(divCeil(t, clockPeriod())); } 222 223 inline Tick cyclesToTicks(Cycles c) const 224 { return clockPeriod() * c; } 225}; 226 227/** 228 * The ClockedObject class extends the SimObject with a clock and 229 * accessor functions to relate ticks to the cycles of the object. 230 */ 231class ClockedObject 232 : public SimObject, public Clocked 233{ 234 public: 235 ClockedObject(const ClockedObjectParams *p)
| 56#include "params/ClockedObject.hh" 57#include "sim/core.hh" 58#include "sim/clock_domain.hh" 59#include "sim/sim_object.hh" 60 61/** 62 * Helper class for objects that need to be clocked. Clocked objects 63 * typically inherit from this class. Objects that need SimObject 64 * functionality as well should inherit from ClockedObject. 65 */ 66class Clocked 67{ 68 69 private: 70 // the tick value of the next clock edge (>= curTick()) at the 71 // time of the last call to update() 72 mutable Tick tick; 73 74 // The cycle counter value corresponding to the current value of 75 // 'tick' 76 mutable Cycles cycle; 77 78 /** 79 * Align cycle and tick to the next clock edge if not already done. When 80 * complete, tick must be at least curTick(). 81 */ 82 void update() const 83 { 84 // both tick and cycle are up-to-date and we are done, note 85 // that the >= is important as it captures cases where tick 86 // has already passed curTick() 87 if (tick >= curTick()) 88 return; 89 90 // optimise for the common case and see if the tick should be 91 // advanced by a single clock period 92 tick += clockPeriod(); 93 ++cycle; 94 95 // see if we are done at this point 96 if (tick >= curTick()) 97 return; 98 99 // if not, we have to recalculate the cycle and tick, we 100 // perform the calculations in terms of relative cycles to 101 // allow changes to the clock period in the future 102 Cycles elapsedCycles(divCeil(curTick() - tick, clockPeriod())); 103 cycle += elapsedCycles; 104 tick += elapsedCycles * clockPeriod(); 105 } 106 107 /** 108 * The clock domain this clocked object belongs to 109 */ 110 ClockDomain &clockDomain; 111 112 protected: 113 114 /** 115 * Create a clocked object and set the clock domain based on the 116 * parameters. 117 */ 118 Clocked(ClockDomain &clk_domain) 119 : tick(0), cycle(0), clockDomain(clk_domain) 120 { 121 // Register with the clock domain, so that if the clock domain 122 // frequency changes, we can update this object's tick. 123 clockDomain.registerWithClockDomain(this); 124 } 125 126 Clocked(Clocked &) = delete; 127 Clocked &operator=(Clocked &) = delete; 128 129 /** 130 * Virtual destructor due to inheritance. 131 */ 132 virtual ~Clocked() { } 133 134 /** 135 * Reset the object's clock using the current global tick value. Likely 136 * to be used only when the global clock is reset. Currently, this done 137 * only when Ruby is done warming up the memory system. 138 */ 139 void resetClock() const 140 { 141 Cycles elapsedCycles(divCeil(curTick(), clockPeriod())); 142 cycle = elapsedCycles; 143 tick = elapsedCycles * clockPeriod(); 144 } 145 146 public: 147 148 /** 149 * Update the tick to the current tick. 150 * 151 */ 152 inline void updateClockPeriod() const 153 { 154 update(); 155 } 156 157 /** 158 * Determine the tick when a cycle begins, by default the current one, but 159 * the argument also enables the caller to determine a future cycle. When 160 * curTick() is on a clock edge, the number of cycles in the parameter is 161 * added to curTick() to be returned. When curTick() is not aligned to a 162 * clock edge, the number of cycles in the parameter is added to the next 163 * clock edge. 164 * 165 * @param cycles The number of cycles into the future 166 * 167 * @return The start tick when the requested clock edge occurs. Precisely, 168 * this tick can be 169 * curTick() + [0, clockPeriod()) + clockPeriod() * cycles 170 */ 171 inline Tick clockEdge(Cycles cycles = Cycles(0)) const 172 { 173 // align tick to the next clock edge 174 update(); 175 176 // figure out when this future cycle is 177 return tick + clockPeriod() * cycles; 178 } 179 180 /** 181 * Determine the current cycle, corresponding to a tick aligned to 182 * a clock edge. 183 * 184 * @return When curTick() is on a clock edge, return the Cycle corresponding 185 * to that clock edge. When curTick() is not on a clock edge, return the 186 * Cycle corresponding to the next clock edge. 187 */ 188 inline Cycles curCycle() const 189 { 190 // align cycle to the next clock edge. 191 update(); 192 193 return cycle; 194 } 195 196 /** 197 * Based on the clock of the object, determine the start tick of the first 198 * cycle that is at least one cycle in the future. When curTick() is at the 199 * current cycle edge, this returns the next clock edge. When calling this 200 * during the middle of a cycle, this returns 2 clock edges in the future. 201 * 202 * @return The start tick of the first cycle that is at least one cycle in 203 * the future. Precisely, the returned tick can be in the range 204 * curTick() + [clockPeriod(), 2 * clockPeriod()) 205 */ 206 Tick nextCycle() const 207 { return clockEdge(Cycles(1)); } 208 209 inline uint64_t frequency() const 210 { 211 return SimClock::Frequency / clockPeriod(); 212 } 213 214 inline Tick clockPeriod() const 215 { 216 return clockDomain.clockPeriod(); 217 } 218 219 inline double voltage() const 220 { 221 return clockDomain.voltage(); 222 } 223 224 inline Cycles ticksToCycles(Tick t) const 225 { return Cycles(divCeil(t, clockPeriod())); } 226 227 inline Tick cyclesToTicks(Cycles c) const 228 { return clockPeriod() * c; } 229}; 230 231/** 232 * The ClockedObject class extends the SimObject with a clock and 233 * accessor functions to relate ticks to the cycles of the object. 234 */ 235class ClockedObject 236 : public SimObject, public Clocked 237{ 238 public: 239 ClockedObject(const ClockedObjectParams *p)
|
236 : SimObject(p), Clocked(*p->clk_domain) { }
| 240 : SimObject(p), Clocked(*p->clk_domain), 241 _currPwrState(p->default_p_state), 242 prvEvalTick(0) 243 { } 244 245 /** Parameters of ClockedObject */ 246 typedef ClockedObjectParams Params; 247 const Params* params() const 248 { return reinterpret_cast<const Params*>(_params); } 249 250 void serialize(CheckpointOut &cp) const override; 251 void unserialize(CheckpointIn &cp) override; 252 253 inline Enums::PwrState pwrState() const 254 { return _currPwrState; } 255 256 inline std::string pwrStateName() const 257 { return Enums::PwrStateStrings[_currPwrState]; } 258 259 /** Returns the percentage residency for each power state */ 260 std::vector<double> pwrStateWeights() const; 261 262 /** 263 * Record stats values like state residency by computing the time 264 * difference from previous update. Also, updates the previous evaluation 265 * tick once all stats are recorded. 266 * Usually called on power state change and stats dump callback. 267 */ 268 void computeStats(); 269 270 void pwrState(Enums::PwrState); 271 void regStats(); 272 273 protected: 274 275 /** To keep track of the current power state */ 276 Enums::PwrState _currPwrState; 277 278 Tick prvEvalTick; 279 280 Stats::Scalar numPwrStateTransitions; 281 Stats::Distribution pwrStateClkGateDist; 282 Stats::Vector pwrStateResidencyTicks; 283
|
237}; 238
| 284}; 285
|
| 286class ClockedObjectDumpCallback : public Callback 287{ 288 ClockedObject *co; 289 public: 290 ClockedObjectDumpCallback(ClockedObject *co_t) : co(co_t) {} 291 virtual void process() { co->computeStats(); }; 292}; 293
|
239#endif //__SIM_CLOCKED_OBJECT_HH__
| 294#endif //__SIM_CLOCKED_OBJECT_HH__
|