src/sim/power/power_model.hh

   1 /*
   2  * Copyright (c) 2016, 2018 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 #ifndef __SIM_POWER_POWER_MODEL_HH__
  39 #define __SIM_POWER_POWER_MODEL_HH__
  40
  41 #include "base/statistics.hh"
  42 #include "enums/PMType.hh"
  43 #include "params/PowerModel.hh"
  44 #include "params/PowerModelState.hh"
  45 #include "sim/probe/probe.hh"
  46
  47 class SimObject;
  48 class ClockedObject;
  49
  50 /**
  51  * A PowerModelState is an abstract class used as interface to get power
  52  * figures out of SimObjects
  53  */
  54 class PowerModelState : public SimObject
  55 {
  56   public:
  57
  58     typedef PowerModelStateParams Params;
  59     PowerModelState(const Params *p);
  60
  61     /**
  62      * Get the dynamic power consumption.
  63      *
  64      * @return Power (Watts) consumed by this object (dynamic component)
  65      */
  66     virtual double getDynamicPower() const = 0;
  67
  68     /**
  69      * Get the static power consumption.
  70      *
  71      * @return Power (Watts) consumed by this object (static component)
  72      */
  73     virtual double getStaticPower() const = 0;
  74
  75     /**
  76      * Temperature update.
  77      *
  78      * @param temp Current temperature of the HW part (Celsius)
  79      */
  80     virtual void setTemperature(double temp) { _temp = temp; }
  81
  82     void setClockedObject(ClockedObject * clkobj) {
  83         clocked_object = clkobj;
  84     }
  85
  86     void regStats() {
  87         SimObject::regStats();
  88
  89         dynamicPower
  90           .method(this, &PowerModelState::getDynamicPower)
  91           .name(params()->name + ".dynamic_power")
  92           .desc("Dynamic power for this object (Watts)")
  93         ;
  94
  95         staticPower
  96           .method(this, &PowerModelState::getStaticPower)
  97           .name(params()->name + ".static_power")
  98           .desc("Static power for this object (Watts)")
  99         ;
 100     }
 101
 102   protected:
 103     Stats::Value dynamicPower, staticPower;
 104
 105     /** Current temperature */
 106     double _temp;
 107
 108     /** The clocked object we belong to */
 109     ClockedObject * clocked_object;
 110 };
 111
 112 /**
 113  * @sa \ref gem5PowerModel "gem5 Power Model"
 114  *
 115  * A PowerModel is a class containing a power model for a SimObject.
 116  * The PM describes the power consumption for every power state.
 117  */
 118 class PowerModel : public SimObject
 119 {
 120   public:
 121
 122     typedef PowerModelParams Params;
 123     PowerModel(const Params *p);
 124
 125     /**
 126      * Get the dynamic power consumption.
 127      *
 128      * @return Power (Watts) consumed by this object (dynamic component)
 129      */
 130     double getDynamicPower() const;
 131
 132     /**
 133      * Get the static power consumption.
 134      *
 135      * @return Power (Watts) consumed by this object (static component)
 136      */
 137     double getStaticPower() const;
 138
 139     void regStats() {
 140         SimObject::regStats();
 141
 142         dynamicPower
 143           .method(this, &PowerModel::getDynamicPower)
 144           .name(params()->name + ".dynamic_power")
 145           .desc("Dynamic power for this power state")
 146         ;
 147
 148         staticPower
 149           .method(this, &PowerModel::getStaticPower)
 150           .name(params()->name + ".static_power")
 151           .desc("Static power for this power state")
 152         ;
 153     }
 154
 155     void setClockedObject(ClockedObject *clkobj);
 156
 157     virtual void regProbePoints();
 158
 159     void thermalUpdateCallback(const double & temp);
 160
 161   protected:
 162     /** Listener class to catch thermal events */
 163     class ThermalProbeListener : public ProbeListenerArgBase<double>
 164     {
 165       public:
 166         ThermalProbeListener(PowerModel &_pm, ProbeManager *pm,
 167                       const std::string &name)
 168             : ProbeListenerArgBase(pm, name), pm(_pm) {}
 169
 170         void notify(const double &temp)
 171         {
 172             pm.thermalUpdateCallback(temp);
 173         }
 174
 175       protected:
 176         PowerModel &pm;
 177     };
 178
 179     Stats::Value dynamicPower, staticPower;
 180
 181     /** Actual power models (one per power state) */
 182     std::vector<PowerModelState*> states_pm;
 183
 184     /** Listener to catch temperature changes in the SubSystem */
 185     std::unique_ptr<ThermalProbeListener> thermalListener;
 186
 187     /** The subsystem this power model belongs to */
 188     SubSystem * subsystem;
 189
 190     /** The clocked object we belong to */
 191     ClockedObject * clocked_object;
 192
 193     /** The type of power model - collects all power, static or dynamic only */
 194     Enums::PMType power_model_type;
 195 };
 196
 197 #endif