clocked_object.hh revision 14163
12810Srdreslin@umich.edu/* 211375Sandreas.hansson@arm.com * Copyright (c) 2012-2013, 2015-2016 ARM Limited 311051Sandreas.hansson@arm.com * Copyright (c) 2013 Cornell University 411051Sandreas.hansson@arm.com * All rights reserved 511051Sandreas.hansson@arm.com * 611051Sandreas.hansson@arm.com * The license below extends only to copyright in the software and shall 711051Sandreas.hansson@arm.com * not be construed as granting a license to any other intellectual 811051Sandreas.hansson@arm.com * property including but not limited to intellectual property relating 911051Sandreas.hansson@arm.com * to a hardware implementation of the functionality of the software 1011051Sandreas.hansson@arm.com * licensed hereunder. You may use the software subject to the license 1111051Sandreas.hansson@arm.com * terms below provided that you ensure that this notice is replicated 1211051Sandreas.hansson@arm.com * unmodified and in its entirety in all distributions of the software, 1311051Sandreas.hansson@arm.com * modified or unmodified, in source code or in binary form. 1411051Sandreas.hansson@arm.com * 1511051Sandreas.hansson@arm.com * Redistribution and use in source and binary forms, with or without 162810Srdreslin@umich.edu * modification, are permitted provided that the following conditions are 172810Srdreslin@umich.edu * met: redistributions of source code must retain the above copyright 182810Srdreslin@umich.edu * notice, this list of conditions and the following disclaimer; 192810Srdreslin@umich.edu * redistributions in binary form must reproduce the above copyright 202810Srdreslin@umich.edu * notice, this list of conditions and the following disclaimer in the 212810Srdreslin@umich.edu * documentation and/or other materials provided with the distribution; 222810Srdreslin@umich.edu * neither the name of the copyright holders nor the names of its 232810Srdreslin@umich.edu * contributors may be used to endorse or promote products derived from 242810Srdreslin@umich.edu * this software without specific prior written permission. 252810Srdreslin@umich.edu * 262810Srdreslin@umich.edu * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 272810Srdreslin@umich.edu * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 282810Srdreslin@umich.edu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 292810Srdreslin@umich.edu * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 302810Srdreslin@umich.edu * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 312810Srdreslin@umich.edu * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 322810Srdreslin@umich.edu * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 332810Srdreslin@umich.edu * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 342810Srdreslin@umich.edu * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 352810Srdreslin@umich.edu * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 362810Srdreslin@umich.edu * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 372810Srdreslin@umich.edu * 382810Srdreslin@umich.edu * Authors: Andreas Hansson 392810Srdreslin@umich.edu * Christopher Torng 402810Srdreslin@umich.edu * Akash Bagdia 412810Srdreslin@umich.edu * David Guillen Fandos 4211051Sandreas.hansson@arm.com */ 4311051Sandreas.hansson@arm.com 442810Srdreslin@umich.edu/** 4511051Sandreas.hansson@arm.com * @file 4611051Sandreas.hansson@arm.com * ClockedObject declaration and implementation. 472810Srdreslin@umich.edu */ 482810Srdreslin@umich.edu 492810Srdreslin@umich.edu#ifndef __SIM_CLOCKED_OBJECT_HH__ 502810Srdreslin@umich.edu#define __SIM_CLOCKED_OBJECT_HH__ 5111051Sandreas.hansson@arm.com 522810Srdreslin@umich.edu#include "base/callback.hh" 532810Srdreslin@umich.edu#include "base/intmath.hh" 5411051Sandreas.hansson@arm.com#include "enums/PwrState.hh" 552810Srdreslin@umich.edu#include "params/ClockedObject.hh" 5612334Sgabeblack@google.com#include "sim/core.hh" 5711051Sandreas.hansson@arm.com#include "sim/clock_domain.hh" 5811051Sandreas.hansson@arm.com#include "sim/sim_object.hh" 5911051Sandreas.hansson@arm.com 6011051Sandreas.hansson@arm.com/** 6111288Ssteve.reinhardt@amd.com * Helper class for objects that need to be clocked. Clocked objects 6211051Sandreas.hansson@arm.com * typically inherit from this class. Objects that need SimObject 6311051Sandreas.hansson@arm.com * functionality as well should inherit from ClockedObject. 6411051Sandreas.hansson@arm.com */ 6511051Sandreas.hansson@arm.comclass Clocked 6611051Sandreas.hansson@arm.com{ 6711053Sandreas.hansson@arm.com 6811053Sandreas.hansson@arm.com private: 6911051Sandreas.hansson@arm.com // the tick value of the next clock edge (>= curTick()) at the 7011051Sandreas.hansson@arm.com // time of the last call to update() 7111051Sandreas.hansson@arm.com mutable Tick tick; 7211197Sandreas.hansson@arm.com 7311197Sandreas.hansson@arm.com // The cycle counter value corresponding to the current value of 7411199Sandreas.hansson@arm.com // 'tick' 7511197Sandreas.hansson@arm.com mutable Cycles cycle; 7612084Sspwilson2@wisc.edu 7712084Sspwilson2@wisc.edu /** 7811197Sandreas.hansson@arm.com * Align cycle and tick to the next clock edge if not already done. When 7911051Sandreas.hansson@arm.com * complete, tick must be at least curTick(). 8011051Sandreas.hansson@arm.com */ 8111051Sandreas.hansson@arm.com void 8211051Sandreas.hansson@arm.com update() const 8311051Sandreas.hansson@arm.com { 8411051Sandreas.hansson@arm.com // both tick and cycle are up-to-date and we are done, note 8511051Sandreas.hansson@arm.com // that the >= is important as it captures cases where tick 8611051Sandreas.hansson@arm.com // has already passed curTick() 8711051Sandreas.hansson@arm.com if (tick >= curTick()) 8811051Sandreas.hansson@arm.com return; 8911051Sandreas.hansson@arm.com 9011051Sandreas.hansson@arm.com // optimise for the common case and see if the tick should be 9111051Sandreas.hansson@arm.com // advanced by a single clock period 9211051Sandreas.hansson@arm.com tick += clockPeriod(); 9311051Sandreas.hansson@arm.com ++cycle; 9411051Sandreas.hansson@arm.com 9511051Sandreas.hansson@arm.com // see if we are done at this point 9611051Sandreas.hansson@arm.com if (tick >= curTick()) 9711051Sandreas.hansson@arm.com return; 9811051Sandreas.hansson@arm.com 9911051Sandreas.hansson@arm.com // if not, we have to recalculate the cycle and tick, we 10011051Sandreas.hansson@arm.com // perform the calculations in terms of relative cycles to 10111051Sandreas.hansson@arm.com // allow changes to the clock period in the future 10211051Sandreas.hansson@arm.com Cycles elapsedCycles(divCeil(curTick() - tick, clockPeriod())); 10311051Sandreas.hansson@arm.com cycle += elapsedCycles; 10411051Sandreas.hansson@arm.com tick += elapsedCycles * clockPeriod(); 10511051Sandreas.hansson@arm.com } 10611051Sandreas.hansson@arm.com 10711051Sandreas.hansson@arm.com /** 10811051Sandreas.hansson@arm.com * The clock domain this clocked object belongs to 10911051Sandreas.hansson@arm.com */ 11011051Sandreas.hansson@arm.com ClockDomain &clockDomain; 11111051Sandreas.hansson@arm.com 11211051Sandreas.hansson@arm.com protected: 11311051Sandreas.hansson@arm.com 11411051Sandreas.hansson@arm.com /** 11511051Sandreas.hansson@arm.com * Create a clocked object and set the clock domain based on the 11611051Sandreas.hansson@arm.com * parameters. 11711051Sandreas.hansson@arm.com */ 11811051Sandreas.hansson@arm.com Clocked(ClockDomain &clk_domain) 11911051Sandreas.hansson@arm.com : tick(0), cycle(0), clockDomain(clk_domain) 12011051Sandreas.hansson@arm.com { 12111051Sandreas.hansson@arm.com // Register with the clock domain, so that if the clock domain 12211051Sandreas.hansson@arm.com // frequency changes, we can update this object's tick. 12311051Sandreas.hansson@arm.com clockDomain.registerWithClockDomain(this); 12411051Sandreas.hansson@arm.com } 12511051Sandreas.hansson@arm.com 12611051Sandreas.hansson@arm.com Clocked(Clocked &) = delete; 12711051Sandreas.hansson@arm.com Clocked &operator=(Clocked &) = delete; 12811051Sandreas.hansson@arm.com 12911051Sandreas.hansson@arm.com /** 13011051Sandreas.hansson@arm.com * Virtual destructor due to inheritance. 13111051Sandreas.hansson@arm.com */ 13211051Sandreas.hansson@arm.com virtual ~Clocked() { } 13311051Sandreas.hansson@arm.com 13411051Sandreas.hansson@arm.com /** 13511051Sandreas.hansson@arm.com * Reset the object's clock using the current global tick value. Likely 13611051Sandreas.hansson@arm.com * to be used only when the global clock is reset. Currently, this done 13711051Sandreas.hansson@arm.com * only when Ruby is done warming up the memory system. 13811051Sandreas.hansson@arm.com */ 13911051Sandreas.hansson@arm.com void 14011051Sandreas.hansson@arm.com resetClock() const 14111051Sandreas.hansson@arm.com { 14211051Sandreas.hansson@arm.com Cycles elapsedCycles(divCeil(curTick(), clockPeriod())); 14311051Sandreas.hansson@arm.com cycle = elapsedCycles; 14411051Sandreas.hansson@arm.com tick = elapsedCycles * clockPeriod(); 14511051Sandreas.hansson@arm.com } 14611051Sandreas.hansson@arm.com 14711051Sandreas.hansson@arm.com /** 14811051Sandreas.hansson@arm.com * A hook subclasses can implement so they can do any extra work that's 14911051Sandreas.hansson@arm.com * needed when the clock rate is changed. 15011601Sandreas.hansson@arm.com */ 15111601Sandreas.hansson@arm.com virtual void clockPeriodUpdated() {} 15211051Sandreas.hansson@arm.com 15311051Sandreas.hansson@arm.com public: 15411051Sandreas.hansson@arm.com 15511051Sandreas.hansson@arm.com /** 15611051Sandreas.hansson@arm.com * Update the tick to the current tick. 15711051Sandreas.hansson@arm.com */ 15811051Sandreas.hansson@arm.com void 15911051Sandreas.hansson@arm.com updateClockPeriod() 16011051Sandreas.hansson@arm.com { 16111051Sandreas.hansson@arm.com update(); 16211284Sandreas.hansson@arm.com clockPeriodUpdated(); 16311051Sandreas.hansson@arm.com } 16411051Sandreas.hansson@arm.com 16511051Sandreas.hansson@arm.com /** 16611051Sandreas.hansson@arm.com * Determine the tick when a cycle begins, by default the current one, but 16711051Sandreas.hansson@arm.com * the argument also enables the caller to determine a future cycle. When 16811051Sandreas.hansson@arm.com * curTick() is on a clock edge, the number of cycles in the parameter is 16911051Sandreas.hansson@arm.com * added to curTick() to be returned. When curTick() is not aligned to a 17011284Sandreas.hansson@arm.com * clock edge, the number of cycles in the parameter is added to the next 17111284Sandreas.hansson@arm.com * clock edge. 17211284Sandreas.hansson@arm.com * 17311284Sandreas.hansson@arm.com * @param cycles The number of cycles into the future 17411051Sandreas.hansson@arm.com * 17511284Sandreas.hansson@arm.com * @return The start tick when the requested clock edge occurs. Precisely, 17611051Sandreas.hansson@arm.com * this tick can be 17711051Sandreas.hansson@arm.com * curTick() + [0, clockPeriod()) + clockPeriod() * cycles 17811051Sandreas.hansson@arm.com */ 17911284Sandreas.hansson@arm.com Tick 18011284Sandreas.hansson@arm.com clockEdge(Cycles cycles=Cycles(0)) const 18111284Sandreas.hansson@arm.com { 18211284Sandreas.hansson@arm.com // align tick to the next clock edge 18311051Sandreas.hansson@arm.com update(); 18411744Snikos.nikoleris@arm.com 18511051Sandreas.hansson@arm.com // figure out when this future cycle is 18611051Sandreas.hansson@arm.com return tick + clockPeriod() * cycles; 18711051Sandreas.hansson@arm.com } 18811051Sandreas.hansson@arm.com 18911286Sandreas.hansson@arm.com /** 19011286Sandreas.hansson@arm.com * Determine the current cycle, corresponding to a tick aligned to 19111286Sandreas.hansson@arm.com * a clock edge. 19211051Sandreas.hansson@arm.com * 19311286Sandreas.hansson@arm.com * @return When curTick() is on a clock edge, return the Cycle corresponding 19411600Sandreas.hansson@arm.com * to that clock edge. When curTick() is not on a clock edge, return the 19511600Sandreas.hansson@arm.com * Cycle corresponding to the next clock edge. 19611051Sandreas.hansson@arm.com */ 19711051Sandreas.hansson@arm.com Cycles 19811051Sandreas.hansson@arm.com curCycle() const 19911284Sandreas.hansson@arm.com { 20011051Sandreas.hansson@arm.com // align cycle to the next clock edge. 20111051Sandreas.hansson@arm.com update(); 20211051Sandreas.hansson@arm.com 20311602Sandreas.hansson@arm.com return cycle; 20411051Sandreas.hansson@arm.com } 20511051Sandreas.hansson@arm.com 20611284Sandreas.hansson@arm.com /** 20711051Sandreas.hansson@arm.com * Based on the clock of the object, determine the start tick of the first 20811284Sandreas.hansson@arm.com * cycle that is at least one cycle in the future. When curTick() is at the 20911602Sandreas.hansson@arm.com * current cycle edge, this returns the next clock edge. When calling this 21011051Sandreas.hansson@arm.com * during the middle of a cycle, this returns 2 clock edges in the future. 21111051Sandreas.hansson@arm.com * 21211284Sandreas.hansson@arm.com * @return The start tick of the first cycle that is at least one cycle in 21311051Sandreas.hansson@arm.com * the future. Precisely, the returned tick can be in the range 21411284Sandreas.hansson@arm.com * curTick() + [clockPeriod(), 2 * clockPeriod()) 21511284Sandreas.hansson@arm.com */ 21611284Sandreas.hansson@arm.com Tick nextCycle() const { return clockEdge(Cycles(1)); } 21711051Sandreas.hansson@arm.com 21811051Sandreas.hansson@arm.com uint64_t frequency() const { return SimClock::Frequency / clockPeriod(); } 21911051Sandreas.hansson@arm.com 22011284Sandreas.hansson@arm.com Tick clockPeriod() const { return clockDomain.clockPeriod(); } 22111284Sandreas.hansson@arm.com 22211284Sandreas.hansson@arm.com double voltage() const { return clockDomain.voltage(); } 22311284Sandreas.hansson@arm.com 22411051Sandreas.hansson@arm.com Cycles 22511051Sandreas.hansson@arm.com ticksToCycles(Tick t) const 22611051Sandreas.hansson@arm.com { 22711284Sandreas.hansson@arm.com return Cycles(divCeil(t, clockPeriod())); 22811284Sandreas.hansson@arm.com } 22911284Sandreas.hansson@arm.com 23011197Sandreas.hansson@arm.com Tick cyclesToTicks(Cycles c) const { return clockPeriod() * c; } 23111601Sandreas.hansson@arm.com}; 23211601Sandreas.hansson@arm.com 23311601Sandreas.hansson@arm.com/** 23411601Sandreas.hansson@arm.com * The ClockedObject class extends the SimObject with a clock and 23511601Sandreas.hansson@arm.com * accessor functions to relate ticks to the cycles of the object. 23611601Sandreas.hansson@arm.com */ 23711601Sandreas.hansson@arm.comclass ClockedObject : public SimObject, public Clocked 23811601Sandreas.hansson@arm.com{ 23911197Sandreas.hansson@arm.com public: 24011601Sandreas.hansson@arm.com ClockedObject(const ClockedObjectParams *p); 24111601Sandreas.hansson@arm.com 24211601Sandreas.hansson@arm.com /** Parameters of ClockedObject */ 24311601Sandreas.hansson@arm.com typedef ClockedObjectParams Params; 24411601Sandreas.hansson@arm.com const Params * 24511601Sandreas.hansson@arm.com params() const 24611601Sandreas.hansson@arm.com { 24711051Sandreas.hansson@arm.com return reinterpret_cast<const Params*>(_params); 24811051Sandreas.hansson@arm.com } 24911051Sandreas.hansson@arm.com 25011051Sandreas.hansson@arm.com void serialize(CheckpointOut &cp) const override; 25111051Sandreas.hansson@arm.com void unserialize(CheckpointIn &cp) override; 25211284Sandreas.hansson@arm.com 25311284Sandreas.hansson@arm.com Enums::PwrState pwrState() const { return _currPwrState; } 25411051Sandreas.hansson@arm.com 25511051Sandreas.hansson@arm.com std::string 25611051Sandreas.hansson@arm.com pwrStateName() const 25711051Sandreas.hansson@arm.com { 25811284Sandreas.hansson@arm.com return Enums::PwrStateStrings[_currPwrState]; 25911051Sandreas.hansson@arm.com } 26011051Sandreas.hansson@arm.com 26111602Sandreas.hansson@arm.com /** Returns the percentage residency for each power state */ 26211602Sandreas.hansson@arm.com std::vector<double> pwrStateWeights() const; 26311602Sandreas.hansson@arm.com 26411602Sandreas.hansson@arm.com /** 26511602Sandreas.hansson@arm.com * Record stats values like state residency by computing the time 26611602Sandreas.hansson@arm.com * difference from previous update. Also, updates the previous evaluation 26711602Sandreas.hansson@arm.com * tick once all stats are recorded. 26811602Sandreas.hansson@arm.com * Usually called on power state change and stats dump callback. 26911602Sandreas.hansson@arm.com */ 27011602Sandreas.hansson@arm.com void computeStats(); 27111602Sandreas.hansson@arm.com 27211051Sandreas.hansson@arm.com void pwrState(Enums::PwrState); 27311602Sandreas.hansson@arm.com void regStats() override; 27411197Sandreas.hansson@arm.com 27511744Snikos.nikoleris@arm.com protected: 27611744Snikos.nikoleris@arm.com 27711051Sandreas.hansson@arm.com /** To keep track of the current power state */ 27811051Sandreas.hansson@arm.com Enums::PwrState _currPwrState; 27911051Sandreas.hansson@arm.com 28011051Sandreas.hansson@arm.com Tick prvEvalTick; 28111051Sandreas.hansson@arm.com 28211051Sandreas.hansson@arm.com Stats::Scalar numPwrStateTransitions; 28311051Sandreas.hansson@arm.com Stats::Distribution pwrStateClkGateDist; 28411051Sandreas.hansson@arm.com Stats::Vector pwrStateResidencyTicks; 28511051Sandreas.hansson@arm.com 28611051Sandreas.hansson@arm.com}; 28711051Sandreas.hansson@arm.com 28811051Sandreas.hansson@arm.comclass ClockedObjectDumpCallback : public Callback 28911051Sandreas.hansson@arm.com{ 29011051Sandreas.hansson@arm.com ClockedObject *co; 29111051Sandreas.hansson@arm.com public: 29211051Sandreas.hansson@arm.com ClockedObjectDumpCallback(ClockedObject *co_t) : co(co_t) {} 29311051Sandreas.hansson@arm.com virtual void process() { co->computeStats(); }; 29411051Sandreas.hansson@arm.com}; 29511051Sandreas.hansson@arm.com 29611051Sandreas.hansson@arm.com#endif //__SIM_CLOCKED_OBJECT_HH__ 29711744Snikos.nikoleris@arm.com